Contributing

Local setup

Install development tools:

uv sync

Install benchmark and docs tools as needed:

uv sync --group bench --group docs

Checks

Run the standard project checks:

make check

Run the documentation build:

make docs

Benchmarks

Run benchmark comparisons locally with:

make benchmark

Release-related workflows

• publish.yaml builds and publishes tagged releases to PyPI
• pypi-smoke.yaml installs the published release from PyPI and runs a smoke test
• docs.yaml builds the documentation on pull requests and deploys it from main

Documentation style

• keep examples runnable
• prefer explicit commands over hand-wavy setup text
• document fallback behavior only when it reflects current implementation