docs(#366): add API pattern replication guidance to AGENTS.md - #418
docs(#366): add API pattern replication guidance to AGENTS.md#418fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Instruct code agents to read existing sibling methods before implementing new methods that call the same API endpoint or use the same multi-step API pattern. Covers replicating error handling (truncation checks, 404-to-ErrNotFound mapping), retry logic (retryOnTransient), and response validation. Prevents a class of medium-severity review findings where new methods omit error handling that existing methods already implement for the same endpoint. Closes #366
|
🤖 Finished Review · ✅ Success · Started 11:56 AM UTC · Completed 12:02 PM UTC |
Review — PR #418Verdict: approve SummaryDocs-only PR adding a 4-line "API pattern replication" section to AGENTS.md, traceable to issue #366. The guidance instructs code agents to replicate error handling, retry logic, and response validation from existing sibling methods when implementing new methods that use the same API endpoint. Technical accuracy: All claims verified against source — Editorial note: The PR correctly omitted Security: No injection patterns, secrets, Unicode steganography, or bidirectional text overrides detected in the diff or PR body. Findings
Previous runReview — PR #418Verdict: ✅ Approve SummaryThis PR adds a 4-line "API pattern replication" section to AGENTS.md, instructing code agents to replicate error handling, retry logic, and response validation from existing sibling methods when implementing new methods that use the same API endpoint. The change closes #366. Dimensions evaluated
No findings at low severity or above.
Previous run (2)ReviewVerdict: Approve SummaryClean, well-scoped docs-only change that adds API pattern replication guidance to AGENTS.md. The PR directly addresses issue #366 and the added text is technically accurate. Verification
Findings
Labels: PR modifies only AGENTS.md documentation |
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 1:08 PM UTC · Completed 1:13 PM UTC |
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 1:43 PM UTC · Completed 1:48 PM UTC |
🔧 Fix agent — iteration 1 (human-triggered)No fixes applied. Review body was empty and no human instruction was provided. The PR's sole changed file (AGENTS.md) is a protected path. Disagreed (1):
Tests: passed Updated by fullsend fix agent |
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 6:19 AM UTC · Completed 6:26 AM UTC |
|
|
||
| **When reviewing PRs:** Flag any direct `exec.Command("gh", ...)`, raw GitHub API calls, or other forge-specific operations outside `internal/forge/github/` as a medium-severity or higher finding. This is an architectural violation, not a style preference. | ||
|
|
||
| ## API pattern replication |
There was a problem hiding this comment.
[low] style
Heading level: the new section uses ## (top-level heading) for a single paragraph of forge-specific implementation guidance. The document convention for this kind of guidance is bold-label paragraphs within an existing section (e.g., Mint function:, When reviewing PRs:). Issue #366 proposed bold-label format. Consider reformatting as a bold-label paragraph within the Forge abstraction section to match the organizational pattern.
Instruct code agents to read existing sibling methods before implementing new methods that call the same API endpoint or use the same multi-step API pattern. Covers replicating error handling (truncation checks, 404-to-ErrNotFound mapping), retry logic (retryOnTransient), and response validation.
Prevents a class of medium-severity review findings where new methods omit error handling that existing methods already implement for the same endpoint.
Closes #366
Post-script verification
agent/366-api-pattern-replication)aa6585ddb3dff17dccfd4dba8b6c5c306275156a..HEAD)