Contributing#
Contributions are always greatly appreciated and credit will always be given.
Types of contributions#
Report bugs#
Report bugs at martibosch/detectree#issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Fix bugs#
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement features#
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Pull request guidelines#
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check https://travis-ci.org/martibosch/detectree/pull_requests and make sure that the tests pass for all supported Python versions.
Adhere to the following project standards:
black
code style with max line length of 79isort
sorted importsnumpy
style docstrings