architecture / changing-something-big

architecture / changing-something-big

Changing something big

v0.12.0 · 05 / 05 · 1 min read · docs/ARCHITECTURE.md

The order that keeps the claims honest:

sh scripts/bench.sh baseline     # 1. capture before
# 2. make the change, with tests
go test -race ./...              # 3. the whole suite still green
go run . --eval                  # 4. the contract still holds
WR=$PWD/wr python3 scripts/qa/mcp_smoke.py   # 5. the protocol still answers
sh scripts/bench.sh compare      # 6. no regression over the threshold
sh scripts/bench.sh profile X    # 7. profiles if you touched a hot path

Commits are Conventional Commits (releases are cut by release-please from them), and the hook installed by scripts/setup-hooks.sh runs gofmt, vet and the tests on commit. Export nothing from package main unless a caller outside it truly needs it; prefer another mode of the binary (like --mcp) over a new public API.

edit this page on GitHub ↗report a problem ↗