Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (26 loc) · 817 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 817 Bytes

Contributing

Workflow

  1. Read AGENTS.md before making non-trivial changes.
  2. Follow relevant files under context/ and skills/.
  3. Keep changes small, test-backed, and architecture-aligned.

Quality Gate

Run before opening a PR:

cargo fmt --all --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace
scripts/validate_openapi_live.sh

Git Hooks

Install project hooks:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install pre-commit openapi-spec-validator==0.7.2
pre-commit install --hook-type pre-commit --hook-type pre-push

Documentation

Update docs when behavior changes:

  • README.md for user-facing behavior.
  • docs/ARCHITECTURE.md for system/model changes.
  • context/ files for workflow or readiness changes.