Skip to content

docs(#5932): state that unmerged ADRs can be edited without revision annotations - #5933

Merged
ifireball merged 1 commit into
mainfrom
agent/5932-adr-unmerged-edit-guidance
Aug 5, 2026
Merged

docs(#5932): state that unmerged ADRs can be edited without revision annotations#5933
ifireball merged 1 commit into
mainfrom
agent/5932-adr-unmerged-edit-guidance

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

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

  • Add one sentence to the "New ADRs in pull requests" section of docs/contributing/adrs.md stating that unmerged ADRs should be edited directly without "Revised" annotations, revision dates, or revision history sections

Testing

  • make lint could not run (sandbox network restriction); manual verification required
  • No tests needed — documentation-only change

Checklist

  • PR title follows Conventional Commits (correct type, ! for breaking changes)
  • No DCO sign-off required (autonomous agent commit)
  • Change is minimal and scoped to the issue

Closes #5932

Post-script verification

  • Branch is not main/master (agent/5932-adr-unmerged-edit-guidance)
  • Secret scan passed (gitleaks — 6ceb2c008662793559cc19687e02364480011fed..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

…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
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner August 5, 2026 13:38
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Aug 5, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 5, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 1:39 PM UTC · Completed 1:48 PM UTC
Commit: 2576928 · View workflow run →

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

Site preview

Preview: https://101a10bd-site.fullsend-ai.workers.dev

Commit: 25769282b79b41d1cb664e051aae9f38e65f887f

@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me


Labels: PR modifies documentation under docs/contributing/

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge component/docs User-facing documentation labels Aug 5, 2026
@ifireball ifireball self-assigned this Aug 5, 2026
@ifireball
ifireball added this pull request to the merge queue Aug 5, 2026
Merged via the queue into main with commit a066e87 Aug 5, 2026
31 checks passed
@ifireball
ifireball deleted the agent/5932-adr-unmerged-edit-guidance branch August 5, 2026 21:18
@fullsend-ai-retro

fullsend-ai-retro Bot commented Aug 5, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 9:20 PM UTC · Completed 9:33 PM UTC
Commit: 2576928 · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

Retro: PR #5933 — ADR unmerged-edit convention fix

The PR #5933 workflow was clean and efficient. The retro system worked as designed:

  1. Origin: On PR #5916 (a complex 20-file feature PR with 6 fix iterations), the fix agent in iteration 2 incorrectly added a *Revised 2026-08-05:...* annotation to ADR 0082 — a document that existed only on the PR branch and had never merged to main. The review agent approved that commit despite observing the annotation (it quoted "section 2, revised 2026-08-05" in an architectural-coherence finding). Human reviewer rh-hemartin caught the issue 25 minutes later. A third fix iteration was needed to remove the annotation.

  2. Retro detection: The retro agent correctly identified the root cause: docs/contributing/adrs.md had no explicit rule about editing unmerged ADRs. It filed #5932 with precise proposed wording and validation criteria.

  3. Fix pipeline: Triage → code → review completed in ~20 minutes (triage run, code run, review run). The code agent produced the correct one-line change on the first attempt. Zero fix iterations were needed.

  4. Review: The review agent approved appropriately for this single-line docs change. Human approval (ifireball) came ~7.5 hours later with no additional findings.

No novel proposals — all improvement areas are tracked

Every improvement opportunity identified from this workflow chain is already covered by existing open issues:

Assessment

This 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 docs/contributing/adrs.md will see the explicit guidance). The human's comment on PR #5916 — "I'm just afraid of trying to get it to fix it, in case it will add some other junk somewhere else" — highlights ongoing fix agent trust concerns, but these are being addressed through the issues cited above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs User-facing documentation ready-for-merge All reviewers approved — ready to merge ready-for-review Triggers review agent dispatch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ADR conventions should state that unmerged ADRs can be edited freely without revision annotations

1 participant