Skip to content

Clarify who can get a PR reviewed. #378

Open
@jmacdotorg

Description

@jmacdotorg
Contributor

IIUC, CR will review your pull request if one of the following is true:

  • The PR is in a public repository.
  • The PR is in a private repository, and your organization has a Pro account, and you have a seat assigned to you.

The overview about code reviews should make this more clear.

Activity

added
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on Jun 4, 2025
traycerai

traycerai commented on Jun 4, 2025

@traycerai

Plan

Observations

The current “Review pull requests” guide covers review triggers, interactions, and commands but doesn’t clearly state upfront who is eligible for a CodeRabbit review. Readers must infer from examples and scattered notes. Surfacing eligibility rules before diving into automation details will reduce confusion and make plan requirements explicit.

Approach

We will modify docs/guides/code-review-overview.md: import the ProPlanNotice MDX component at the top, then insert a new “## Review eligibility {#eligibility}” section immediately after the introduction. This section will list public vs. private repository rules as bullets, include <ProPlanNotice /> under the private-repo bullet, and resume the existing “Automatically review pull requests” section unchanged.

Reasoning

After reviewing ticket #378, we confirmed the target file path, component location and import syntax, documentation style patterns, and linking/sidebar conventions. All prerequisites are satisfied, so we can draft this precise edit plan without additional setup.

Proposed File Changes

📄 docs/guides/code-review-overview.md (MODIFY) 🔗

References
  1. Add an MDX import for the ProPlanNotice component immediately after the YAML front-matter:

    import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'
  2. Insert a new section after the introduction (before “Automatically review pull requests”):

    ## Review eligibility {#eligibility}
    
    CodeRabbit will review your pull request if one of the following is true:
    
    - **Public repositories:** CodeRabbit reviews every PR by default.
    - **Private repositories:** CodeRabbit reviews PRs only when your organization has a Pro plan and you have an assigned seat.
    
    <ProPlanNotice />
  3. Ensure the heading level, bullet formatting, and tone match the surrounding document. No other sections need adjustment.

Import In IDE

VSCode Icon Cursor Icon Windsurf Icon

Developer Humor

Public PRs? Reviewed every time! 🐇
Private PRs? Only with a Pro seat, sublime ✨
Now eligibility’s clear, no more guesswork or pain
Ivory docs updated to keep knowledge in frame 📚
CodeRabbit hops in, reviews again and again! 🐰🎉


Execution Information

Branch: main
Commit: 35720e8


💡 Tips

Supported Commands (Inside Comments)

  • Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

  • Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
  • Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs triageA new docs bug that needs to be processed and planned by the docs project owners

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jmacdotorg

        Issue actions

          Clarify who can get a PR reviewed. · Issue #378 · coderabbitai/coderabbit-docs