Problem
Several issues are tagged good first issue but there are no contributor guidelines explaining:
- How to set up the dev environment (
uv, conda, .venv)
- How to run CI locally (
just ci)
- Code style expectations (ruff
select = ["ALL"], mypy strict, Google docstrings)
- Branch/PR workflow
Proposed
Add CONTRIBUTING.md at repo root covering:
- Setup:
uv sync --all-extras or equivalent
- Workflow:
just format → just check → just ci before committing
- Testing:
pytest --cov, coverage threshold
- Style: ruff + mypy strict, Google docstrings,
from __future__ import annotations
- PRs: one issue per PR, descriptive commit messages
Problem
Several issues are tagged
good first issuebut there are no contributor guidelines explaining:uv, conda,.venv)just ci)select = ["ALL"], mypy strict, Google docstrings)Proposed
Add
CONTRIBUTING.mdat repo root covering:uv sync --all-extrasor equivalentjust format→just check→just cibefore committingpytest --cov, coverage thresholdfrom __future__ import annotations