docs(agents): reduce duplication and add concise writing guidance#1010
Conversation
📝 WalkthroughWalkthroughThis PR streamlines AGENTS.md by consolidating and shortening guidance for AI agents. It replaces explicit “When to Read CONTRIBUTING.md” and “IMPORTANT” directives with an agent-specific prompt to consult CONTRIBUTING.md for standards and commit formats; tightens Essential Rules (conciseness, ask before large speculative changes, avoid inventing patterns); condenses command documentation (removed per-command commentary and Pre-commit Hooks, renamed sections to “Setup” and “File-Scoped” with simplified examples); trims Code Patterns and Commit Message sections to brief pointers; and normalizes wording and punctuation. Net change: +33 / -142 lines. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
|
@mergify rebase |
Reduce from 233 to 123 lines by removing content duplicated in CONTRIBUTING.md and using references instead. Add concise writing guidance as a top-level rule. Closes: python-wheel-build#879 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Lalatendu Mohanty <lmohanty@redhat.com>
✅ Branch has been successfully rebased |
12b15ee to
c44e85d
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 102-110: Update the AI attribution footer in the AGENTS.md commit
example so it matches the repository's exact required string; replace the
existing "Co-Authored-By: Claude <claude@anthropic.com>" with the exact required
footer "Co-Authored-By: Claude <claudeanthropic.com>" in the example commit
block and ensure the surrounding guidance text still states to add that footer
when AI agents create or significantly modify code.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Reduce from 233 to 123 lines by removing content duplicated in CONTRIBUTING.md and using references instead. Add concise writing guidance as a top-level rule.
Closes: #879