We want to make contributing to this project as easy and transparent as possible. If you identify a bug or have a feature request please open an issue. If you discover a new method or an improvement on the models, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement" if you discover an issue but don't have a solution.
Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. The recommended issue format is:
How to reproduce the issue.
Expected output.
Your environment.
Test project:
pytest .Lint project: Linting is required for PRs. Lint via ruff or use the provided pre commit hooks.
Hooks can be installed from .pre-commit-config.yaml. For example:
$ pip install pre-commit$ pre-commit install
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - If you've changed APIs, update the documentation.
- Ensure the test suite passes (
pytest). These are also required for PRs. - Make sure your code lints (
ruff). This is also required for PRs.
We use