docs(#5932): state that unmerged ADRs can be edited without revision annotations - #5933
Conversation
…annotations Add explicit guidance to the "New ADRs in pull requests" section of docs/contributing/adrs.md: when editing an ADR that has not yet merged to main, change the content directly without adding "Revised" annotations, revision dates, or revision history sections. This rule was implicit in "Approval happens at merge" but agents did not infer it, causing a fix agent to add an unnecessary revision date to a brand-new ADR on PR #5916. Note: pre-commit and make lint could not run in the sandbox (network restriction prevented fetching origin). Manual verification of lint is required. Closes #5932
|
🤖 Finished Review · ✅ Success · Started 1:39 PM UTC · Completed 1:48 PM UTC |
Site previewPreview: https://101a10bd-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Looks good to me Labels: PR modifies documentation under docs/contributing/ |
|
🤖 Finished Retro · ✅ Success · Started 9:20 PM UTC · Completed 9:33 PM UTC |
Retro: PR #5933 — ADR unmerged-edit convention fixThe PR #5933 workflow was clean and efficient. The retro system worked as designed:
No novel proposals — all improvement areas are trackedEvery improvement opportunity identified from this workflow chain is already covered by existing open issues:
AssessmentThis is the retro system working well: a real incident on PR #5916 was correctly diagnosed, a targeted fix was proposed and implemented, and the fix is self-correcting (future review agents reading |
Summary
Add explicit guidance to the ADR conventions that unmerged ADRs on a PR branch can be edited directly without revision annotations. This was implicit but agents did not infer it, causing unnecessary fix iterations on PR #5916.
Related Issue
Changes
docs/contributing/adrs.mdstating that unmerged ADRs should be edited directly without "Revised" annotations, revision dates, or revision history sectionsTesting
make lintcould not run (sandbox network restriction); manual verification requiredChecklist
!for breaking changes)Closes #5932
Post-script verification
agent/5932-adr-unmerged-edit-guidance)6ceb2c008662793559cc19687e02364480011fed..HEAD)