Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.2 KB

Contributing

First-Time Setup

Run from repo root:

make setup

This creates .venv and installs hash-pinned development dependencies from requirements-dev.lock.

Daily Commands

Use these commands only:

make dev
make check
make test
make test-e2e

Command intent:

  • make dev: Reinstall locked development dependencies into the active project interpreter.
  • make check: Full non-mutating quality gate (format-check, lint, typecheck, guard, coverage, security, bench).
  • make test: Unit/integration lane (not e2e).
  • make test-e2e: Opt-in browser lane (e2e).

Pull Request Requirements

  • Keep diffs small and scoped.
  • Add or update deterministic tests for any behavior change.
  • Run make check before opening the PR.
  • Update README.MD when command or configuration workflow changes.
  • Update CHANGELOG.md for user-visible changes.

Local Hook Install

.venv/bin/pre-commit install --install-hooks --hook-type pre-commit --hook-type pre-push

Install the hooks before normal development. Commit-time checks handle fast formatting and secret scanning, while the push hook runs the repo gate so broken changes fail locally instead of after GitHub upload.