Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.36 KB
Raw

Contributing

Contributions are always greatly appreciated and credit will always be given.

Types of contributions

Report bugs

Report bugs at https://github.com/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:

  1. The pull request should include tests.
  2. 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.
  3. 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.
  4. Adhere to the following project standards:
    • black code style with max line length of 79
    • isort sorted imports
    • numpy style docstrings