Skip to content

[AGENTS] guideline for comments - #7030

Merged
youknowone merged 1 commit into
RustPython:mainfrom
youknowone:agents-comment
Feb 6, 2026
Merged

[AGENTS] guideline for comments#7030
youknowone merged 1 commit into
RustPython:mainfrom
youknowone:agents-comment

Conversation

@youknowone

@youknowone youknowone commented Feb 6, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated development guidelines with new best practices for code documentation, including standards for preserving existing comments, avoiding unnecessary decorative separators, and refactoring duplicate code logic across branches.

@youknowone youknowone added the skip:ci Skip running the ci label Feb 6, 2026
@youknowone
youknowone marked this pull request as ready for review February 6, 2026 05:30
@youknowone
youknowone merged commit 4f14738 into RustPython:main Feb 6, 2026
8 of 9 checks passed
@youknowone
youknowone deleted the agents-comment branch February 6, 2026 05:30
@coderabbitai

coderabbitai Bot commented Feb 6, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation-only edits to AGENTS.md: added "Comments" guidance under AI Agent Rules and Rust Coding Guidelines, and expanded the "Avoid Duplicate Code in Branches" section with Bad/Good examples showing extraction of common logic.

Changes

Cohort / File(s) Summary
Documentation Updates
AGENTS.md
Added a "Comments" subsection to both AI Agent Rules and Rust Code sections (preserve meaningful comments; avoid decorative separators). Expanded "Avoid Duplicate Code in Branches" with explicit Bad/Good Rust examples demonstrating extraction of shared logic when branches differ only by values.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 I hopped through lines and left a clue,
Preserve the notes that help us do,
Trim the bars that only hide,
Pull the shared bits to unify the ride. 🥕

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip:ci Skip running the ci

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant