Any contribution is welcome on this project whatever it is:
- reporting a bug or feature request
- remarks or comments via an issue
- documentation or feature enhancement via a Pull-Request
For any code change follow the instructions below:
- clone this repository
- do your changes inside your clone
- ensure the project still builds correctly:
mvn verify - for big changes, separate your commits to provide small independent/self-contained/meaningful commits
- if relevant, close or mention existing issues that your contribution refers to or corrects
- push your changes
- ensure the project still builds correctly:
- open a Pull-Request
- describe your change
The project enforces the respect of conventional commits specification. A git hook protects committing bad messages.
This project uses google-java-format an opinionated formatting library via the usage of plugin fmt-maven-plugin
The file formatting is checked both by a git pre-commit hook and with build step.
Follow instructions on google-java-format to setup your IDE correctly.