Contributing¶
Awesome that you are reading this.
This GitHub follows the Contributor Covenant Code of Conduct.
- For questions, you can create an Issue
- Code changes go via Pull Requests
Submitting code¶
Submitted code should follow these quality guidelines:
- The submitted code is considered useful
- The submitted code is tested 100%
- All other tests pass keep passing
Emails with code will not be accepted.
Submitting bugs¶
Awesome. These are your options:
- Add an issue, with the test that fails
- Submit a pull request, with the failing test
- Send @richelbilderbeek an email. @richelbilderbeek will make an issue of it
If the report was good enough to reproduce the bug and the bug was not reported yet, you will be mentioned in the acknowledgements.
Branching policy¶
- The
main
branch is for developers - The
develop
branch should always build successfully