Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.6 KB
Raw

Contributing

Note: In order to contribute you must be a qualified member of the organization.

We accept contributions via Pull Requests.

The current version v1 is under active development.

This means any new feature MUST target v1 (main branch).

Pull Requests

  • Java Code Conventions - The easiest way to apply the conventions is to run a style checker as you code.
  • Add tests! - Your pull request won't be accepted if it doesn't have tests.
  • Document any change in behaviour - Make sure the README and the code documentation are kept up-to-date.
  • Create topic branches - We won't pull from your master branch.
  • One pull request per feature - If your code is changing more than one thing, send multiple pull requests.
  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple commits while developing, please remove them before submitting.
  • Ensure tests pass! - Please run the tests before submitting your pull request, and make sure they pass. We won't accept a pull request until all tests pass.

Bug Reports

When submitting an issue or bug report, please follow the available bug report templates. This will ensure a sufficient standard for fast processing and bug fixing. The more information you provide, the better we can help you. Therefore, always pay attention to a large amount of detail.

Thank you