docs: allow minor annotations on accepted ADRs - #1966
Conversation
Replace the strict "immutable once accepted" policy with a nuanced one: cross-references, short notes linking to newer ADRs, and typo fixes are welcome on accepted ADRs. Substantial rewrites still require a new superseding ADR. This stops agents from refusing to add navigational links between related ADRs while still preventing old ADRs from becoming evolving design documents (that role belongs to docs/architecture.md). Updates both the ADR template and the writing-adrs skill. Assisted-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Ralph Bean <rbean@redhat.com>
Site previewPreview: https://3f228212-site.fullsend-ai.workers.dev Commit: |
ReviewFindingsMedium
Low
Info
Previous runReviewFindingsHigh
Medium
Low
|
| | Skipping linters | Run `make lint` before committing | | ||
| | Wrong ADR number | Check existing files in `docs/ADRs/` first | | ||
| | Editing an accepted ADR's content | Write a new ADR that supersedes it | | ||
| | Substantially rewriting an accepted ADR | Write a new ADR that supersedes it | |
There was a problem hiding this comment.
[low] table-formatting
New table entries 'Not adding cross-references to related ADRs' and 'Using old ADRs as evolving design docs' use a different phrasing pattern than existing mistake entries. Consider 'Omitting cross-references' and 'Treating old ADRs as evolving design docs' for parallel structure.
There was a problem hiding this comment.
Fixed in cb18f31 — "Omitting" and "Treating" now.
Update AGENTS.md, CONTRIBUTING.md, docs/architecture.md, skills/renumber-adr/SKILL.md, and skills/writing-adrs/SKILL.md to distinguish minor annotations from substantial rewrites on accepted ADRs, consistent with the updated template and writing-adrs skill. Fix parallel structure in writing-adrs mistake table entries. Assisted-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Ralph Bean <rbean@redhat.com>
|
Pushed cb18f31. The original PR only updated the template and the writing-adrs skill but left the old strict-immutability language in AGENTS.md, CONTRIBUTING.md, architecture.md, and the renumber-adr skill — so agents would've gotten contradictory instructions depending on which file they read first. All five files now use the same "minor annotations welcome, substantial rewrites prohibited" framing. Also fixed the table entry phrasing for parallel structure. Skipped the old HTML comments in ADRs 0018/0029 — those are cosmetic and can be cleaned up whenever someone's in the neighborhood. |
|
🤖 Retro · Started 3:38 PM UTC |
Retro: PR #1966 — docs: allow minor annotations on accepted ADRsWorkflow went well — no new proposals. This was a human-authored PR (ralphbean) that relaxed the ADR immutability policy to allow minor annotations like cross-references and typo fixes. The review agent delivered genuine value:
Minor edge cases already tracked by existing issues:
No new proposals needed — the pipeline worked as designed. |
|
🤖 Finished Retro · ✅ Success · Started 3:38 PM UTC · Completed 3:44 PM UTC |
Summary
docs/architecture.mdfor evolving design narrativeAgents were getting confused when we'd add notes to old ADRs linking to newer related decisions. The old policy told them ADRs are frozen, so they'd resist adding navigational links. This update draws the line at the right place: annotations that help readers navigate are good, turning old ADRs into living documents is not.
🤖 Generated with Claude Code