docs(#6423): document extract-to-living-doc pattern for ADRs - #6426
docs(#6423): document extract-to-living-doc pattern for ADRs#6426fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add guidance for handling evolving operational details in accepted ADRs. When details like field tables, struct definitions, or merge rules need updating, agents should extract them to a living reference document under docs/contributing/ rather than modifying the ADR. This codifies the pattern already used by docs/contributing/harness-fields.md (which holds evolving field tables from ADR-0045). Changes: - docs/contributing/adrs.md: add "Extracting evolving details to living docs" paragraph after Immutability, and add review heuristic to flag evolving content added to accepted ADRs - skills/writing-adrs/SKILL.md: add "When operational details evolve" section, red flag entry, and common mistake entry Note: make lint could not run (sandbox network policy blocks pre-commit hook installation). Manual verification of lint is required. Closes #6423
Site previewPreview: https://750e01e5-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 5:55 PM UTC · Completed 6:09 PM UTC Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
|
|
Not a real consolidated pattern, instead living table will need to live in the reference part. |
|
🤖 Finished Retro · ✅ Success · Started 12:15 PM UTC · Completed 12:31 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Cost: $5.09 |
Retro: PR #6426 — docs(#6423): document extract-to-living-doc pattern for ADRsOutcome: Closed without merge by Timeline
Total agent cost: ~$5.80 for a rejected 18-line docs change. Human review latency: 6 days. Root causeThe retro agent extrapolated a general convention from a single data point. PR #6398 successfully used a living doc approach for ADR-0045's field tables, and the retro agent characterized this as "the pattern already used by Pipeline observations
Evidence for existing issuesAll improvement opportunities identified are already tracked by open issues. This PR provides additional supporting evidence:
No new proposalsAll identified improvement opportunities are already tracked by open issues. No new proposals are warranted. |
Summary
Adds the "extract to living doc" convention to the ADR contributing guide and the writing-adrs skill. When operational details in an accepted ADR evolve (field tables, struct definitions, merge rules, configuration examples), agents should extract them to a living reference document under
docs/contributing/and link back — rather than modifying the ADR in place.This codifies the pattern already used by
docs/contributing/harness-fields.md(which holds the evolving field tables from ADR-0045) and addresses the gap that led to the rejected PR #6161.Changes
docs/contributing/adrs.md: Added "Extracting evolving details to living docs" paragraph after the Immutability section. Added review heuristic to flag PRs that add evolving operational detail to accepted ADRs.skills/writing-adrs/SKILL.md: Added "When operational details evolve" guidance section with a concrete example. Added corresponding red flag and common mistake entries.Testing
docs/contributing/harness-fields.md,docs/ADRs/0045-forge-portable-harness-schema.md)make lintcould not run due to sandbox network policy blocking pre-commit hook installationCloses #6423
Post-script verification
agent/6423-adr-living-doc-guidance)032e8c45469baad5228d84b4ad9000217fed8f6e..HEAD)