Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.14 KB

CODESTYLE.md

File metadata and controls

26 lines (17 loc) · 1.14 KB

Project Codestyle

General Standard

NameNode Analytics follows the Google Java Styleguide.
We recommend you use IntelliJ IDEA and install the Checkstyle plugin.
Once installed please set-up your plugin to follow the checkstyle underneath config/checkstyle/checkstyle.xml.
Documentation on how to do so can be found here.

Scope

This codestyle is to be applied across all non-binary files within the src/main and src/test directories.

Enforcement

The codestyle is enforced by running ./gradlew checkstyleMain checkstyleTest.
Changes which add additional warnings are subject to peer review and are discouraged.
Any codestyle errors MUST be fixed prior to approving and/or committing.

Attribution

This codestyle standard is adapted from Checkstyle, revision 80365b80228157a07cad060cfd30087487f4b6f9, available here.