Home / Contributing

Contributing to pySTAMPS

Use this process for code, docs, tests, and docs-site cleanup. Keep changes scoped, reproducible, and parity-safe where relevant.

Repository setup

git clone git@github.com:sirbastiano/pystamps.git
cd pystamps
uv sync
python -m pip install -e ".[dev]"

Code quality expectations

  • Keep public behavior deterministic and explicit.
  • Use typed APIs and module-local exception types.
  • Keep parity-sensitive changes scoped and include targeted validation evidence.

Standard PR workflow

  1. Keep each PR focused on one intent.
  2. Run relevant tests before asking for review.
  3. Include reproducible commands in the PR description.
  4. Run parity checks when touching pipeline math or kernel behavior.

Branching model

Use short-lived feature branches with one purpose per branch. Merge after validation gates pass.

git checkout -b feat/your-change
git add .
git commit -m "docs: add contributing page"

Documentation updates

When docs change, update both narrative pages and generated API references so nav and cross-links stay valid.

For repository-wide guidance, see CONTRIBUTING.md.