46 lines (35 loc) · 777 Bytes

Contributing

Development Setup

python -m venv .venv
source .venv/bin/activate
make dev

Local Quality Checks

Run these before opening a pull request:

make fmt
make lint
make type
make docstrings-check
make test
make docs-check
make examples-smoke
make ci

Optional but useful:

pre-commit install
pre-commit run --all-files

Pull Request Guidelines

Keep PRs focused and reasonably small.
Add or update tests for behavior changes.
Update docs/examples when interfaces or workflows change.
Describe what changed and how you validated it.

Code Style

Python 3.12+ target
Ruff for linting and formatting
Mypy for type checking
Pytest for tests
Google-style docstrings in src/, examples/, and scripts/