docs(#1299): document forge.Client abstraction convention#1304
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#1299): document forge.Client abstraction convention#1304fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
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]>
Site previewPreview: https://1b93651e-site.fullsend-ai.workers.dev Commit: |
ReviewFindingsNo 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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
agent/1299-document-forge-abstraction)33244271743c5a6ab9af8038f2bd69e8d1610ab7..HEAD)