Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (29 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.25 KB
Raw

Contributing

Contributions are welcome through issues, discussions, and pull requests.

Development Setup

python3 -m pip install -U -e ".[test]"
python3 -m pip install -U pre-commit
pre-commit install

Local Checks

pytest
pre-commit run --all-files

The pre-commit hooks include ruff and pyright (pinned to the same version CI uses), so a clean local run means a clean CI run. The pyright hook resolves imports from your .venv, so make sure the editable install above ran inside it.

Style Notes

  • Keep changes focused and include tests when behavior changes.
  • The codebase is pyright-clean (standard mode, Python 3.9 target) and CI enforces it. Prefer real fixes (honest annotations, explicit narrowing) over suppressions; when a suppression is unavoidable (inherently dynamic APIs), use a rule-specific # pyright: ignore[ruleName], never a blanket # type: ignore.

Need Help?

Recommended Reading