We welcome contributions from the community! Whether you are reporting or fixing a bug, implementing a new feature, or improving the documentation, your contribution is appreciated.
To set up a development environment, follow these steps:
Fork the repository on GitHub and clone your fork locally
Create a virtual environment and activate it
Install pre-commit to manage git hooks
pip install pre-commit pre-commit install
Install the package in editable mode along with development dependencies
Implement your changes in a new branch
Commit your changes with clear messages
Push your branch to your fork and open a pull request against the main repository
Ensure all tests pass and request a review
After setting up the development environment, you can build the documentation locally:
pip install tox # only the first time
tox -e doc
# The built documentation will be in `docs/build/html/index.html`If you encounter any bugs or have feature requests, please file an issue on GitHub. Open a new issue.
When filing an issue, provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant logs or screenshots.