Repository navigation
docs(adr): add the ADR format guide and the write route - #3799
Conversation
…t to the agent-guidance gate
Size Report
Startup median (7 runs, lower is better):
|
|
The independent review by a different model provider found four text corrections at
The new format budget, affected selector, workflow paths, and routing proof match the requested ownership. The exact-commit gate passed with an unchanged checkout. I assigned one repair round. Review of that head and CI remain required. |
…wners with the issue Review repairs for #3744 wording: the Decision history line stays a permission, PR logs and status change-logs route to the umbrella issue, the 8 KB figure reads as an approximate upper aim, and the AGENTS.md qualifiers return with meaning-neutral compressions.
|
Repair round at
Validation: |
|
The independent review by a different model provider is complete at I compared each changed sentence with base The format file owns a 4,000-byte budget. The affected selector and both workflow triggers reach its existing guidance check. The routing proof covers a format-only edit. Receipt |
|
Ready at I checked issue comments, reviews, and inline threads. No findings or open threads remain. The independent review by a different model provider is complete. The exact-commit receipt passed with an unchanged checkout. The check rollup contains 17 passes, one skipped cache job, and a neutral Cubic check. The neutral check does not replace the completed independent review. The maintainer owns the merge. After merge, I will post the current state on #3744 and start the ADR 0003/0008 pilot. |
|
I reviewed 8e46e04 and it is ready for human review. The code looks good, and all 19 checks pass with none failing. There are no conflicts. Not blocking, and you can take or leave these: README.md and FORMAT.md both set shape conventions, and they differ slightly (FORMAT.md makes sections optional and allows a dated Decision history line, while README.md deletes process history), so one file could own them, for example in the ADR 0003/0008 pilot PR. The 8 KB ADR size target at FORMAT.md line 121 has no gate, since the new 4,000-byte budget covers only FORMAT.md itself. |
|
Summary
Part of #3744. First restructure batch: authoring rules only. No ADR record changes.
docs/adr/FORMAT.md: when to write an ADR (the three-condition test), what it contains (decision, reason, rejected alternatives, consequences/gaps), what it excludes and where each item goes, the living-record rule with the optional dated "Decision history" line, the amend procedure, the restructure ledger rule, and the about-8 KB approximate upper aim.AGENTS.mdroute: "Read architecture decisions" goes todocs/adr/README.md; "Write or amend an ADR" goes todocs/adr/FORMAT.md.docs/adr/FORMAT.mdits own 4000-byte budget in the agent-guidance contract test, routes it to theagent-guidancegate in the affected selector and the workflow, and extends the existing routing proof. No overall budget increase, no allowlist, no general ADR size gate.Migration ledger
AGENTS.mdread route: kept, intent reworded ("Read architecture decisions").AGENTS.mdwrite route: new, todocs/adr/FORMAT.md.docs/adr/FORMAT.md.Validation
Independent review by a different model provider is complete. No findings remain. All required CI checks pass. The branch is CLEAN and mergeable.
8e46e04c1e;pnpm check:affected --run --head 8e46e04c1ec1edc07490e90ad572dfed01b06a5dpassed,exactCommit=true,checkoutChanged=false.check:agent-guidance,check-affectedmodel tests, gate workflow/routing tests, doc prose/links tests;pnpm formatandtypecheckclean.