Document review-comment style and approval gate in AGENTS.md#1397
Merged
Conversation
Add guidance to the PR Review section so review feedback is consistent and low-noise: - Get explicit user approval before posting any review feedback to GitHub, even when asked to review a PR (clarifies PR Process step 6). - Keep each comment terse: problem, minimal context, what to do instead. - Anchor comments inline; keep the summary body to must-address points. - Verify against the rest of the repo before claiming a convention violation; scope to concrete inconsistencies. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for testcontainers-node ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
cristianrgreco
added
documentation
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
1 participant
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.
Summary
Adds guidance to the PR Review section of
AGENTS.mdso PR review feedback from contributors and coding agents is consistent and low-noise. Prompted by a review where comments were overly verbose and one made a repo-wide convention claim that wasn't accurate.New guidance:
Why
Review comments were verbose and not consistently actionable for the PR author, and a "no one does X" claim turned out to be wrong on closer inspection. Encoding these expectations in
AGENTS.mdkeeps future reviews focused and prevents low-value or inaccurate comments.Changes
AGENTS.md— docs-only addition to the## PR Reviewsection.Verification
Docs-only change (no code, no public API). No build/test impact.
Semver
Not breaking — documentation-only change to contributor guidance.