Contributing¶
Thanks for considering a contribution!
Contributor License Agreement required. Before a contribution can be merged, contributors must agree to the CLA. By opening a pull request you agree to its terms; sign your commits with
git commit -s. SeeCONTRIBUTING.mdfor details. The maintainer may decline any contribution.
Use Python 3.11–3.13.
Run tests locally with
pytest.Keep functions documented and small; prefer pure utilities over monoliths.
Docs live under
docs/(Sphinx + MyST). Build withmake htmlfrom thedocsdirectory.
Building docs locally¶
pip install -e .[docs]
cd docs && make html
open build/html/index.html # macOS