Contributing¶
Contributions are welcome! Please review the repository's contribution guidelines and code-quality tools before submitting a pull request.
Development setup¶
- Install uv and create a virtual environment:
uv venv .venv
uv sync --frozen --extra dev
uv pip install -e .
- Run quality checks locally:
uv run ruff check .
uv run pyright
uv run pytest -n auto
- Optional: build the Rust extension for faster local testing:
make rust-build
Pull requests¶
- Keep changes focused and include tests where practical.
- Update documentation when user-facing behavior changes.
- Ensure type hints remain accurate; see the Typing page for details.