docs(#201): add cross-reference update guidance to AGENTS.md - #287
docs(#201): add cross-reference update guidance to AGENTS.md#287fullsend-ai-coder[bot] wants to merge 2 commits into
Conversation
When implementing a feature previously described as in progress or planned, contributors should search for and update stale references in the same PR. The new bullet includes the > **Planned** callout format from ADR 0023 and defers to the ADR immutability rules for Accepted ADRs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
🤖 Finished Review · ✅ Success · Started 9:18 AM UTC · Completed 9:24 AM UTC |
Review — ✅ ApprovePR: #287 — docs(#201): add cross-reference update guidance to AGENTS.md Change summaryAdds a single bullet to the "How to work in this repo" section of AGENTS.md, instructing contributors to search for and update stale documentation references (e.g., "in progress", "coming soon", "planned", Dimension assessmentsCorrectness: The new bullet is correctly placed in the "How to work in this repo" list, between existing guidance bullets. The internal anchor link Security: Documentation-only change with no code execution surface. CODEOWNERS ( Intent & coherence: The change directly implements the guidance requested in issue #201, which documented a real gap: PR fullsend-ai#2773 merged with stale "in progress" references that the review agent flagged across 7 consecutive runs without resolution. The PR body accurately describes the change and its relationship to the superseded #225 (which lacked the Style/conventions: The bullet follows the established format of other items in the section: imperative voice, specific actionable guidance, consistent markdown formatting. The line length is comparable to other long bullets in the file (e.g., the DCO guidance). Commit messages follow the Documentation currency: The change is itself documentation guidance. The ADR immutability cross-reference is accurate — the "limit changes to minor annotations" phrasing aligns with the existing ADR rules on lines 69-73 (allowing "cross-references, short notes, typo fixes" on Accepted ADRs). Cross-repo contracts: Not applicable — no external API surface affected. FindingsNo findings at or above the Notes for human reviewerThis PR modifies AGENTS.md, which governs agent and contributor behavior across the repository. The
Previous runReview — PR #287Verdict: ✅ Approve SummaryThis PR adds a single bullet point to AGENTS.md's "How to work in this repo" section, instructing contributors to search for and update stale "in progress"/"coming soon"/"planned" references when implementing a previously-described feature. The change correctly implements the guidance requested in issue #201 with two well-motivated additions beyond the issue's proposed text: the Review dimensionsCorrectness: No issues. All cross-references verified:
Security: No issues. The diff is a docs-only, single-line addition with no secrets, injection patterns, Unicode steganography, or permission changes. Intent & coherence: The change traces directly to issue #201. The two additions beyond the issue's proposed text (ADR 0023 callout term and immutability qualifier) are appropriate refinements that close gaps in the original proposal. The change is properly scoped — one file, one bullet, matching the documented ask. AGENTS.md is the correct location for contributor workflow guidance. Style & conventions: The new bullet is consistent with the existing section. At ~65 words it is well within the range established by the DCO bullet (~78 words) on line 15. The use of italics for referenced term concepts ( Documentation currency: No staleness introduced. CLAUDE.md delegates to AGENTS.md as the single source of truth, and no other documentation files reference the specific guidance area being modified. Cross-repo contracts: Skipped — no exported interfaces, schemas, or public APIs are modified. Notes for human reviewerAGENTS.md is covered by CODEOWNERS (
Previous run (2)ReviewFindingsMedium
Previous run (3)Review — ApprovePR: #287 — SummaryClean, well-scoped documentation change that adds a single bullet to AGENTS.md's "How to work in this repo" section. The guidance instructs contributors to search for and update stale "in progress"/"coming soon"/"planned" doc references when implementing a feature that was previously described as upcoming. Dimensions evaluated
Findings[low]
Labels: PR modifies AGENTS.md documentation only. |
|
/fs-review |
|
🤖 Review · ❌ Terminated · Started 10:27 AM UTC · Ended 10:38 AM UTC |
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 10:27 AM UTC · Completed 10:38 AM UTC |
|
🤖 Finished Review · ✅ Success · Started 10:39 AM UTC · Completed 10:45 AM UTC |
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 11:12 AM UTC · Completed 11:19 AM UTC |
Replace 'per the ADR immutability rules below' with a markdown anchor link to the Architecture Decision Records section, preventing silent breakage if the heading is renamed or moved. Addresses review feedback on #287
🔧 Fix agent — iteration 1 (human-triggered)Addressed 1 review finding: replaced prose-based cross-reference with markdown anchor link in AGENTS.md. Pre-commit and lint failures are due to sandbox infrastructure issue (shellcheck-py proxy block), not code quality. Fixed (1):
Tests: passed Updated by fullsend fix agent |
|
🤖 Finished Review · ✅ Success · Started 11:21 AM UTC · Completed 11:25 AM UTC |
Summary
> **Planned**callout format from ADR 0023 in the search terms, which PR docs(#201): add cross-reference update guidance to AGENTS.md #225 omittedSupersedes #225, which implemented the same guidance without the ADR 0023 callout term or the immutability qualifier.
Closes #201
Test plan
make lintpasses (lint failure in CI is a pre-existing shellcheck environment issue, not related to this change)