Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

docs: clarify PR review eligibility (#378) #396

Merged
merged 3 commits into from
Jul 9, 2025
Merged

docs: clarify PR review eligibility (#378) #396

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
057d05d
docs: clarify PR review eligibility (#378)
hardikkgupta Jun 11, 2025
e7368f8
docs: rewrite eligibility section
hardikkgupta Jul 8, 2025
55eb231
docs: remove excess bolding
hardikkgupta Jul 8, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/guides/code-review-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: An overview of CodeRabbit's core code review features.
sidebar_label: Overview
---

import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'

The central feature of CodeRabbit is its ability to proactively review
new pull requests on your code repository.

Expand All @@ -14,6 +16,15 @@ This information, usually added to pull requests within minutes, can help your t
The following sections present an overview of this feature. For a hands-on example that lets you experience a CodeRabbit code review using
a real repository, see [Quickstart](/getting-started/quickstart).

## Review eligibility {#eligibility}
Copy link
Contributor

Choose a reason for hiding this comment

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

Since many of our headers start with imperative verbs, I am cautious about starting headers with "Review" as a noun like this, since it's ambiguous. This could be read as "Here is how you review something for eligibility."

How about moving this into a level-three section, after the "Events that trigger automated reviews" section? And retitling it "Which pull requests get automatically reviewed".
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

CodeRabbit will review your pull request if one of the following is true:

- **Public repositories:** CodeRabbit reviews every PR by default.
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs a reword for clarity. How about:

"The pull request is part of a public repository. CodeRabbit automatically reviews pull requests against the main branch of your public repositories, by default. This feature is available to all subscription tiers, including the free plan."

Part of my nitpick here is that the list lead-in makes us expect a list or true-or-false statement, but "Public repositories" isn't really a statement that can be true or false. The bolded sentence I suggest above is true-or-false, though. Make sense?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense!
- **Private repositories:** CodeRabbit reviews PRs only when your organization has a Pro plan **and** you have an assigned seat.
Copy link
Contributor

Choose a reason for hiding this comment

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

Apply the same strategy as above to this one, too. (And let's spell out "pull request".)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wrote it as: The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you

<ProPlanNotice />

## Automatically review pull requests {#review}

After you [integrate CodeRabbit with your repository](/platforms), CodeRabbit proceeds
Expand Down
Loading