CONTRIBUTING.rst

Contributing

Contributions are welcome, and they are greatly appreciated!

Types of Contributions

• Have something to say: join us at slack (find how to join in README), or create a ticket at GitHub Issues.
• 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.
  • supported sections
  • docstring examples
• Share your Kestrel analytics: submit a PR to the kestrel-analytics repo.
• Share your Kestrel huntbook: submit a PR to the kestrel-huntbook repo.

Code Style

We follow the symbol naming convention and use black to format the code.

How to Submit a Pull Request

Checklist before submitting a pull request:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated.
3. Run a full unittest with pytest.
4. Check unused imports with unimport --check --exclude __init__.py src/.
5. Black your code with black src/.

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.