All code contributions and bug reports are welcome!
Submit a new issue only if you are sure it is a missing feature or a bug. For questions or if you are unsure visit our discussions.
Issues for newcomers are tagged with 'good first issue' and documentation issues are tagged with 'documentation'.
We would be happy about co-maintainers, so do not hesitate contacting us if you see yourself helping to continue this project!
-
Fork the repo and create a branch for your new feature or bug fix.
-
Run the tests. We only take pull requests with passing tests:
python -m unittest -
Add at least one test for your change. Only refactoring and documentation changes require no new tests. Also make sure you submit a change specific to exactly one issue. If you have ideas for multiple changes please create separate pull requests.
-
Make the test(s) pass.
-
Push to your fork and submit a pull request. A button should appear on your fork its github page afterwards.
All contributions like pull requests, bug fixes, documentation changes and translations fall under the Apache License and contributors agree to our contributor covenant code of conduct.
We use the formatters and linters stated in .pre-commit-config.yaml. We use pre-commit.ci to apply and enforce the formatting rules. They are applied on your changes automatically once you open a Pull Request, so you don't have to bother with formatting. Thanks pre-commit <3