Contributions are welcomed via pull requests on GitHub. Create an issue first to ensure that the proposed changes are in line with the direction of the package.
New features should be applicable to a variety of use-cases.
All changes in a pull request should be closely related. Multiple change sets that are loosely coupled should be proposed in separate pull requests.
All contributors implicitly agree to the Contributor Agreement (ContributorAgreement) when contributing code to this project.
This package prek to ensure consistent formatting of Python code.
Write proper docstrings for all modules, classes, and functions.
In addition write standard # comments when the code is complicated or such comments would improve understanding.
Add unit tests for all new functionality.
Propose a short concise entry describing the change in the pull request description.