Skip to content

docs(agents): reduce duplication and add concise writing guidance#1010

Merged
LalatenduMohanty merged 1 commit intopython-wheel-build:mainfrom
LalatenduMohanty:concise-docs-guidance
Apr 2, 2026
Merged

docs(agents): reduce duplication and add concise writing guidance#1010
LalatenduMohanty merged 1 commit intopython-wheel-build:mainfrom
LalatenduMohanty:concise-docs-guidance

Conversation

@LalatenduMohanty
Copy link
Copy Markdown
Member

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

@LalatenduMohanty LalatenduMohanty requested a review from a team as a code owner April 1, 2026 20:04
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

This 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)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: reducing duplication and adding concise writing guidance to AGENTS.md.
Description check ✅ Passed The description clearly relates to the changeset, explaining the reduction in lines and consolidation of duplicated content while adding concise writing guidance.
Linked Issues check ✅ Passed The PR directly addresses issue #879 by reviewing/updating AGENTS.md, reducing duplication with CONTRIBUTING.md, and adding concise writing guidance as a top-level rule.
Out of Scope Changes check ✅ Passed All changes are scoped to AGENTS.md and align with issue #879's objectives of improving the document structure and adding actionable writing guidance.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread AGENTS.md
Copy link
Copy Markdown
Contributor

@rd4398 rd4398 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@LalatenduMohanty
Copy link
Copy Markdown
Member Author

@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>
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Apr 2, 2026

rebase

✅ Branch has been successfully rebased

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 520735a3-1086-45ec-a4ba-5a6d695cdb6f

📥 Commits

Reviewing files that changed from the base of the PR and between 12b15ee and c44e85d.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md
@LalatenduMohanty LalatenduMohanty merged commit a09f306 into python-wheel-build:main Apr 2, 2026
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve the AGENTS.MD file

2 participants