mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-11 22:14:00 +01:00
Krzysztof kuhy Rudnicki
6c71d531bb
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
67 lines
2.7 KiB
Markdown
67 lines
2.7 KiB
Markdown
# repo_contract
|
|
|
|
Shared gate: every repo tells an agent how to run and test it, so nobody has to
|
|
explore. Enforced like the other shared gates (real gate in `~/src/utils`, a
|
|
thin shim per repo, pre-commit + CI).
|
|
|
|
## The contract
|
|
|
|
`CLAUDE.md` (or `AGENTS.md` that `CLAUDE.md` symlinks to) has a `## Commands`
|
|
section with one line per key, exactly `- <key>: \`<command>\``:
|
|
|
|
```markdown
|
|
## Commands
|
|
|
|
- run: `<command>` | n/a: library
|
|
- test: `<full suite>`
|
|
- test-changed: `scripts/test_changed.sh`
|
|
- lint: `<command>`
|
|
- coverage: `<command writing a report>`
|
|
- coverage-gaps: `coverage-gaps <report>`
|
|
```
|
|
|
|
Rules (all machine-checked):
|
|
|
|
1. All six keys present, once each. A value is a backticked command or
|
|
`n/a: <reason>` / `n/a (<reason>)`. A bare `n/a` fails: n/a carries a reason.
|
|
2. `test-changed` invokes an existing, executable `scripts/test_changed.sh`-style
|
|
script that runs only tests related to files changed vs HEAD, falls back to
|
|
the full suite when it cannot map, and prints failures plus a one-line
|
|
summary only.
|
|
3. `coverage-gaps` runs the shared lister `coverage-gaps <report>`
|
|
(`~/src/utils/coverage_gaps`).
|
|
4. `test`, `test-changed`, `lint`, `coverage` are quiet: no `-v`/`--verbose`/
|
|
expanded reporter, in the command or in the script's runner lines.
|
|
5. No placeholders (`<FILL IN>`, `TODO`, `...`).
|
|
6. If `test` is n/a, then `test-changed`, `coverage`, `coverage-gaps` are n/a
|
|
too, and the repo must contain no tests (bounded scan).
|
|
|
|
## Use
|
|
|
|
```bash
|
|
python3 ~/src/utils/repo_contract/check.py --repo <path> # 0 pass / 1 violations / 2 unreadable
|
|
python3 ~/src/utils/repo_contract/bootstrap.py --repo <path> # print proposal
|
|
python3 ~/src/utils/repo_contract/bootstrap.py --repo <path> --write
|
|
python3 ~/src/utils/repo_contract/sweep.py # ~/data/claude-scratch/repo-contract/SWEEP.md
|
|
```
|
|
|
|
Bootstrap never overwrites: it appends the section (or inserts missing lines at
|
|
the end of an existing `## Commands`), creates `CLAUDE.md -> AGENTS.md` when
|
|
only AGENTS.md exists, and writes `scripts/test_changed.sh` only if absent.
|
|
Sources, in priority order: existing CLAUDE.md, `scripts/<key>.sh`, Makefile,
|
|
package.json (node only), CI workflows, stack defaults. Anything it cannot infer
|
|
is written as `<FILL IN>`, which the gate rejects until a human fills it.
|
|
|
|
## Adding the gate to a repo
|
|
|
|
1. Copy `templates/check_repo_contract.shim.sh` to `scripts/check_repo_contract.sh`
|
|
(never copy `scripts/check_repo_contract.sh` from this repo).
|
|
2. Add `templates/pre-commit-snippet.yaml` to `.pre-commit-config.yaml`.
|
|
3. Copy `templates/repo-contract.yml` to `.github/workflows/`.
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
PYTHONPATH=. python -m pytest repo_contract/tests -q --cov=repo_contract --cov-branch --cov-fail-under=100
|
|
```
|