Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.3 KB
Raw

Contribution guidelines

Basic

  • If there is not one open already, open an issue in GitHub issues
  • Fork this repo
  • Checkout develop branch
  • Apply your changes
    • Make sure all projects build and all unit tests pass
    • Make sure code coverage doesn't drop (add extra unit tests if necessary)
    • If fixing a bug, make sure you add an unit or integration test to expose the issue
    • If adding a new feature, make sure you add an unit or integration test to test the feature
    • If adding a new feature, add end user documentation as well
    • Add comments to the code explaining your changes if necessary
  • Create a pull request to the correct development branch (mention the issue id in the PR comments)

Code style

Make sure to follow the code style of the existing code. That means for example four spaces for indentation.

Commit messages

When committing, make sure the commit message is describing what is changed and why. See the example below.

[issue id] a short description
A more detailed description

Communication

Please send an email to [email protected], or [email protected].

More information

Read more about best practices in this github guide.