Contributor guidelines

We love contributions! Feel free to contribute in any way you like: docs, suggestions, features, fixes tests!

To make both your and our life easier here are some tips:

editorconfig

To make sure that regardless of IDE/editor everyone uses the same settings we use editorconfig. Just make sure that you have the editorconfig plugin for your editor installed.

configure IDE

pull request scope

Keep your pull requests as small as possible. Please, avoid combining code with indentation changes.

semantic messages

Please use semantic commit messages.

Tests and documentation are not optional

  1. All pull requests must contain unit tests so don’t forget to include tests in your pull requests. The unit tests should be added in the corresponding src/test folder of the modified module.
  2. When fixing an issue a test case should be added in the tests folder. Navigate to the tests folder and add a new folder named as follows: feat/issue-github_issue_number-issue_description, then add the code inside it.
  3. Check if some of the examples should be modified.
  4. Also don’t forget the documentation (reference documentation, javadoc…).

Frequently Asked Questions