Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 945 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 945 Bytes
Raw

How to contribute

Contributions are always welcome. Here are a few guidelines to be aware of:

  • Include tests for new behaviours introduced by PRs.
  • Fixed bugs MUST be covered by test(s) to avoid regression.
  • If you are on Unix-like system, you may run ./setup_environment.sh to set up pre-push git hook.
  • All code must follow the project coding style standards which can be achieved by running make cs
  • Before implementing a new big feature, consider creating a new issue on Github. It will save your time when the core team is not going to accept it or has good recommendations about how to proceed.
  • Target master branch

Tests

To run the tests locally, you can run make test. It however requires Docker. For more granular tests, you can run make to see the available commands.


« Go back to the readme »