Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (29 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.19 KB
Raw

Contributing

Thanks for your interest in improving feature-pipeline-quality. This is a small, focused project, so contributions that keep it sharp and dependency-light are especially welcome.

Development setup

python -m pip install -e ".[dev]"

This installs the package in editable mode along with the development tools (ruff, mypy, coverage).

Quality gates

Every change must pass the same checks CI runs:

ruff check src tests        # lint
ruff format --check src tests   # formatting
mypy                        # static types
coverage run -m unittest discover -s tests && coverage report

ruff format src tests will auto-apply the formatting if the check fails.

Pull requests

  1. Fork and create a feature branch.
  2. Keep changes focused; one logical change per PR.
  3. Add or update tests for any behavior change.
  4. Ensure all quality gates pass locally before pushing.
  5. Update CHANGELOG.md under the Unreleased heading.

Design principles

  • Standard library only at runtime — no heavy dependencies.
  • Explicit, machine-readable output (JSON reports, deterministic exit codes).
  • Tests must be deterministic; never assert against the wall clock.