Thank you for your interest in improving this project. This project is open-source under the Apache2.0 license and highly welcomes contributions in the form of bug reports, feature requests, and pull requests.
Here is a list of important resources for contributors:
How to report a bug
Report bugs on the Issue Tracker.
How to request a feature
Request features on the Issue Tracker.
How to set up your development environment
You need Python 3.7+ and the following tools:
You can install them with:
$ pip install poetry nox nox-poetry
Install the package with development requirements:
$ make install
You can now run an interactive Python session, or the command-line interface:
$ poetry run python $ poetry run pypi-latest
How to test the project
Run the full test suite:
List the available Nox sessions:
$ nox --list-sessions
You can also run a specific Nox session. For example, invoke the unit test suite like this:
$ nox --session=tests
Unit tests are located in the
and are written using the pytest testing framework.
How to submit changes
Open a pull request to submit changes to this project against the
Your pull request needs to meet the following guidelines for acceptance:
The Nox test suite must pass without errors and warnings.
Include unit tests. This project maintains a high code coverage.
If your changes add functionality, update the documentation accordingly.
To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:
$ nox --session=pre-commit -- install
It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.