Thank you very much for contributing.
We use a git flow with feature branches. So if you make addition to a feature make a PR to the feature branch and if you created a completely new featutre make a feature branch and than a PR to develop branch.
- Please fork the project
- Work on the code in the fork
- make a PR to the appropriate branch in the main project
If you implement or change code, please run the tests so we can avoid regression. Preferably create tests before working on the code. It is also possible to create tests without adding new code.
This projects uses mockito.
❗ Since 0.5.0 we use assertj for assertions. Please use assertions, that prints real values on failing instead of hash codes.
Please comment on an issue before starting work. This way nobody is wasting time trying to achieve the same thing.
Please use Java Coding Conventions so the code is easily readable for everyone.
Use many small commits during development. Each commit should handle only logical connected change.
Use for the Translator for returning from a Controller.
return Translator.toLocale("message");
Make the changes on the main files outside the language specific folders unless it is a translation. These should only be made inside the language folders.
Please provide a small description as to what you have done and reference any existing issues you have resolved.
Please don't forget to comment PRs with @all-contributors please add <username> for <contributions> in order to update the all contributors list.