Contributing GuideΒΆ
We welcome pull requests! Please follow these steps:
Fork the repository and create a feature branch.
Install dev dependencies:
pip install -e .[dev]
.Run
pre-commit install
to enable linters.Add or update tests β we aim for >95 % coverage.
Ensure
pytest -q
passes.Submit a PR; GitHub Actions will run the test & docs matrix.
Coding styleΒΆ
ruff
enforces import order & flake-like rules.Type hints are mandatory for new code.
DocsΒΆ
All docs live under docs/
and are built by Sphinx. Add a new .md
page and reference it in _toc.yml
.