Contributions are welcome, and they are greatly appreciated!
Types of Contributions
Report bugs: report bugs at GitHub Issues.
Fix bugs: look through the GitHub Issues for bugs to fix.
Implement features: look through the GitHub Issues for features to implement.
Write documentation: we use the Google Style docstrings in our source code.
Share your Kestrel analytics: submit a PR to the kestrel-analytics repo.
Share your Kestrel huntbook: submit a PR to the kestrel-huntbook repo.
How to Submit a Pull Request
Checklist before submitting a pull request:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated.
Run a full unittest with
Check unused imports with
unimport --check --exclude __init__.py src/.
Black your code with
All contributions must be covered by a Contributor’s License Agreement (CLA) and ECLA (if you are contributing on behalf of your employer). You will get a prompt to sign CLA when you submit your first PR.