docs(#3510): add AGENTS.md guidance for review conventions - #3511
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#3510): add AGENTS.md guidance for review conventions#3511fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add two sections to AGENTS.md to prevent false-positive review findings: 1. Go file header convention: documents the repo-wide pattern of placing SPDX license headers before //go:build tags, so review agents do not flag this as a style violation. 2. Security fix review expectations: instructs review agents to flag documentation gaps as informational comments rather than blocking change requests on security-fix PRs. Both patterns were identified from PR #3489 where review agents issued miscalibrated findings. This follows the established pattern of adding AGENTS.md guidance to improve agent review accuracy (similar to #3503, #3508, #3451, #3389, #3458). Note: pre-commit could not run in sandbox (network restriction). The post-script runs it authoritatively. Closes #3510
|
🤖 Finished Review · ✅ Success · Started 3:03 PM UTC · Completed 3:13 PM UTC Commit: |
ReviewFindingsMedium
Labels: PR modifies agent guidance documentation (AGENTS.md) |
fullsend-ai-review
Bot
added
requires-manual-review
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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.
What:
Add two new sections to AGENTS.md to prevent false-positive review findings:
Go file header convention — Documents the repo-wide pattern of placing SPDX license headers before
//go:buildtags. Review agents (fullsend and qodo) were flagging this as a style violation on PR Use ValidateVSAAndComparePolicy for ec validate image VSA skip #3489, but it is an intentional convention across all Go files.Security fix review expectations — Instructs review agents to flag documentation gaps (e.g., missing
THREAT_MODEL.mdorDESIGN.mdupdates) as informational comments rather than blocking change requests when the PR's primary purpose is a security fix. On PR Use ValidateVSAAndComparePolicy for ec validate image VSA skip #3489, the review agent issued REQUEST_CHANGES verdicts in 6 of 10 review cycles for doc gaps on a security fix that both human reviewers considered non-blocking.Why:
Both findings from PR #3489 were technically correct but miscalibrated for this repo's conventions. The build-tag false positive is a straightforward convention gap. The documentation severity miscalibration creates friction and teaches authors to ignore agent verdicts. Adding AGENTS.md guidance follows the established pattern in this repo (#3503, #3508, #3451, #3389, #3458).
Tickets:
Closes #3510
Post-script verification
agent/3510-agents-md-review-guidance)a18338416237ca7c5154a0af499f81d4b821ea46..HEAD)