Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 837 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 837 Bytes

Contributing

Thank you for looking into supporting this project. Any constructive input is greatly appreciated!

Questions and Ideas

Even if you don't have code contributions, but just an idea, or a question, please feel free to open an issue!

Reporting Bugs

  • Please include sample code and traceback (or unexpected behavior) of the error you are experiencing.

  • Also include Python version and Operating System.

Pull Requests

  • Follow PEP8

  • Select to merge into homolog branch, NOT main

  • New features should have

    • An associated issue.
    • Detailed docstrings.
    • Tests with as much coverage as possible.
  • Bug fixes should include

    • Explain under which circumstances the bug occurs in the pull request.
    • Tests.
  • Update CHANGELOG.md to include new feature or fix

  • Add yourself to AUTHORS.md!