docs: broaden the verify-before-acting rule in AGENTS.md - #3309
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAGENTS.md updates contributor guidance to consult existing documentation before duplicating content and to verify claims, including hearsay, against the build and documented command effects. ChangesContributor guidance updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 108-112: Update the “Verify claims before acting on them” guidance
in AGENTS.md so claims are re-checked against the build or the appropriate
authoritative source, preserving the surrounding examples and intent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
The rule named only claims inherited from pull requests and issues, so it did not cover the two sources that actually produced wrong statements while writing these files: a stale project memory, and a conclusion drawn earlier in the same session. Both were copied into a committed file before being caught. Also record that running a documented command only proves it executes -- the output filter in CLAUDE.md ran fine while matching 2968 of 5293 log lines -- and that existing docs should be read before new ones are written.
juherr
force-pushed
the
docs/agents-verify-rules
branch
from
July 29, 2026 15:56
77f71cb to
b5168e6
Compare
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.
Follow-up to #3302, from the retrospective on writing it.
Why
AGENTS.mdshipped with five factual errors, two of them serious — the build JDK was said to live in one place when it lives in six (andtest.ymloverridesgradle.properties), and a failure mode was described that stopped being true when Gradle 9 landed.Both came from sources the existing rule did not name. It covered "a statement inherited from a pull request description, an issue or a comment" — but the actual sources were a stale project memory and a conclusion drawn earlier in the same session. Neither felt like hearsay at the time, which is exactly the problem.
Changes
Three lines, at the two places that failed:
CLAUDE.mdoutput filter ran perfectly while matching 2968 of 5293 log lines — it was verified as "executes", never as "filters".docs/and.github/before writing documentation.AGENTS.mdwas itself written as a fifth copy of material already there, before being cut back to links.Verification
./gradlew clean buildgreen on the merged master — 0 failures. Documentation-only change, so noCHANGES.txtentry, consistent with the otherdocs:commits in this repository.Summary by CodeRabbit