Skip to content

docs(#1299): document forge.Client abstraction convention#1304

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/1299-document-forge-abstraction
Open

docs(#1299): document forge.Client abstraction convention#1304
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/1299-document-forge-abstraction

Conversation

@fullsend-ai-coder
Copy link
Copy Markdown

Add a "Forge abstraction" section to AGENTS.md documenting that all git forge operations must go through the forge.Client interface in internal/forge/forge.go. This gives both the code agent (to write correct code) and the review agent (to catch violations) the architectural context they were missing.

The new section covers:

  • The rule: all forge ops use forge.Client
  • What is prohibited outside internal/forge/github/
  • Where forge-specific code belongs
  • Guidance for extending the interface
  • Review severity for violations (medium or higher)

Also adds a brief mention in CLAUDE.md's Go code section for broader visibility, cross-linking to the full AGENTS.md section.

Note: make lint could not run due to a sandbox infrastructure issue (Go toolchain download permission denied). The changes are documentation-only (Markdown files) so no Go tests apply.


Closes #1299

Post-script verification

  • Branch is not main/master (agent/1299-document-forge-abstraction)
  • Secret scan passed (gitleaks — 33244271743c5a6ab9af8038f2bd69e8d1610ab7..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Add a "Forge abstraction" section to AGENTS.md documenting that all
git forge operations must go through the forge.Client interface in
internal/forge/forge.go. This gives both the code agent (to write
correct code) and the review agent (to catch violations) the
architectural context they were missing.

The new section covers:
- The rule: all forge ops use forge.Client
- What is prohibited outside internal/forge/github/
- Where forge-specific code belongs
- Guidance for extending the interface
- Review severity for violations (medium or higher)

Also adds a brief mention in CLAUDE.md's Go code section for
broader visibility, cross-linking to the full AGENTS.md section.

Note: make lint could not run due to a sandbox infrastructure
issue (Go toolchain download permission denied). The changes
are documentation-only (Markdown files) so no Go tests apply.

Closes #1299

Signed-off-by: fullsend-code <[email protected]>
@github-actions
Copy link
Copy Markdown

Site preview

Preview: https://1b93651e-site.fullsend-ai.workers.dev

Commit: 13b304991394aeec07de71c61cdc634badf3fde8

@fullsend-ai-review
Copy link
Copy Markdown

Review

Findings

No findings.

The PR adds a well-structured "Forge abstraction" section to AGENTS.md and a brief cross-linked mention in CLAUDE.md. The documentation accurately describes the existing forge.Client interface in internal/forge/forge.go and the GitHub implementation in internal/forge/github/. The scope matches the linked issue (#1299) exactly — no drift beyond the authorized work. Commit message follows Conventional Commits format.

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge All reviewers approved — ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AGENTS.md should document the forge.Client abstraction convention

0 participants