Contributor Guide#
Thank you for your interest in improving this project. This project is open-source under the MIT license and 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.
When filing an issue, make sure to answer these questions:
Which operating system and Python version are you using?
Which version of this project are you using?
What did you do?
What did you expect to see?
What did you see instead?
The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.
How to request a feature#
Request features on the Issue Tracker.
How to set up your development environment#
You need to have uv installed. If you don’t have it yet:
$ curl -LsSf https://astral.sh/uv/install.sh | sh
Then set up the development environment:
$ make setup
Or manually:
$ uv sync --all-extras
How to build the project#
Build the documentation:
$ make docs
Or build and serve with auto-reload:
$ make auto
Check documentation links:
$ make linkcheck
How to get help#
$ make help
How to submit changes#
Open a pull request to submit changes to this project.
Your pull request needs to meet the following guidelines for acceptance:
The test suite must pass without errors and warnings.
If your changes add functionality, update the documentation accordingly.
Feel free to submit early, though—we can always iterate on this.
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:
$ uvx 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.