Skip to content

docs(#189): add API pattern replication guidance to AGENTS.md #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fullsend-ai-coder wants to merge 2 commits into from
Closed

docs(#189): add API pattern replication guidance to AGENTS.md #205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b396c6a
docs(#189): add API pattern replication guidance to AGENTS.md
fullsend-ai-coder[bot] Jul 8, 2026
7a7b13e
fix(#189): improve API pattern replication guidance accuracy
fullsend-ai-coder[bot] Jul 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ All git forge operations (GitHub API calls, PR comments, issue creation, workflo

**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

@fullsend-ai-review fullsend-ai-review Bot Jul 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] formatting-consistency

The new section uses a single prose paragraph while sibling sections (e.g., 'Forge abstraction') structure guidance with bold lead-ins for scannability. Consider adding bold lead-ins like 'When implementing:' and 'When reviewing PRs:' to match the established pattern.

When implementing a new method that calls the same API endpoint or uses the same multi-step API pattern as an existing method in the file, read the existing implementation first. Replicate its error handling (e.g., truncation checks, 404-to-ErrNotFound mapping), retry logic (e.g., `retryOnTransient`), and response validation. The `internal/forge/github/github.go` file's `commitFilesTo` method uses the Git Trees API pattern (refs → commit → tree) with truncation handling — any new method using the same endpoint should replicate that handling.

**When reviewing PRs:** Flag new forge methods that omit error handling or retry patterns present in existing methods using the same API endpoint. This is a correctness issue, not a style preference.

## Architecture Decision Records (ADRs)

These rules apply whenever you touch `docs/ADRs/` or review a PR that does. Full authoring guidance is in [`skills/writing-adrs/SKILL.md`](skills/writing-adrs/SKILL.md); invoke that skill when writing a new ADR.
Expand Down
Loading