Use the project facilities on GitHub:
Contributions are welcome!
The project is uses the following services
Try to stick with relevant Clean Code practices.
Maximize the amount of code located in the .internal. packages, as this is off-contract.
The project uses the following configurations:
- Google's CheckStyle configuration
- Default SpotBugs configuration
- Eclipse formatter aligned with the above CheckStyle configuration
As you may have noticed, I'm an Eclipse user and I was so lazy that I included all configuration files in the project.
JavaDocs for all source code located in src/main should be complete.
In my opinion, this is not incompatible with using meaningful names and other clean code practices.
Source code, tests and JavaDoc should be written in English to ease adoption (but I will welcome I18N efforts). As I am not a native speaker, let me know if you find some mistakes in method names, ill-formed sentences or anything similar.
Code coverage should not decrease. However, I think it is OK not to spend too much time testing some highly unlikely exceptions. Let me know if the "unlikely" hypothesis is no more valid.