-
Line endings
- Use Unix line endings when committing (\n)
- Windows users of Git can do
git config --global core.autocrlf trueto let Git convert them automatically
-
Column width
- 80 for Javadocs
- 150 for code
- Feel free to wrap when it will help with readability
-
Indentation
- Use 4 spaces for indentations, do not use 2 spaces
-
Vertical whitespace
- Place a blank line before the first member of a class, interface, enum, etc. (i.e. after class Example {) as well as after the last member
-
File headers
- File headers must contain the license headers for the project. automatically.
-
Imports
- Imports must be grouped in the following order, where each group is separated by an empty line
- All imports
- java imports
- javax imports
- Static imports
- Imports must be grouped in the following order, where each group is separated by an empty line
-
Javadocs
- Do not use @author
- Wrap additional paragraphs in
<p>and</p> - Capitalize the first letter in the descriptions within each “at clause”, i.e. @param name Player to affect, no periods
- Use Optionals instead of returning null in the API
- Method parameters accepting null must be annotated with @Nullable (from javax.*), all methods and parameters are @Nonnull by default.
- Anything you program must be done in a separate branch.
- Before sending a pull request ensure that your branch is up to date with the master branch at origin.
- Please follow the above guidelines for your pull request(s) to be accepted.