From 057d05d9aac9702fbf1715e804298c125558cd1e Mon Sep 17 00:00:00 2001 From: electricplayer <40640596+electricplayer@users.noreply.github.com> Date: Wed, 11 Jun 2025 14:58:04 -0500 Subject: [PATCH 1/3] docs: clarify PR review eligibility (#378) Signed-off-by: electricplayer <40640596+electricplayer@users.noreply.github.com> --- docs/guides/code-review-overview.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/guides/code-review-overview.md b/docs/guides/code-review-overview.md index cd511c76..18a5c954 100644 --- a/docs/guides/code-review-overview.md +++ b/docs/guides/code-review-overview.md @@ -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. @@ -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} + +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. + + + ## Automatically review pull requests {#review} After you [integrate CodeRabbit with your repository](/platforms), CodeRabbit proceeds From e7368f83420bdb0ab91064e257470390ae204478 Mon Sep 17 00:00:00 2001 From: electricplayer <40640596+electricplayer@users.noreply.github.com> Date: Tue, 8 Jul 2025 02:01:55 -0500 Subject: [PATCH 2/3] docs: rewrite eligibility section Signed-off-by: electricplayer <40640596+electricplayer@users.noreply.github.com> --- docs/guides/code-review-overview.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/guides/code-review-overview.md b/docs/guides/code-review-overview.md index 18a5c954..a1505548 100644 --- a/docs/guides/code-review-overview.md +++ b/docs/guides/code-review-overview.md @@ -16,15 +16,6 @@ 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} - -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. - - - ## Automatically review pull requests {#review} After you [integrate CodeRabbit with your repository](/platforms), CodeRabbit proceeds @@ -53,6 +44,15 @@ perform a code review: - If an open pull request that CodeRabbit has already reviewed gets modified with another commit, then CodeRabbit performs an incremental review that focuses on the new commit. +### Which pull requests get automatically reviewed {#eligibility} + +CodeRabbit automatically reviews a pull request when **either** of the following statements is true: + +- **The pull request is in a public repository.** CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan. +- **The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you.** Only under this condition does CodeRabbit review private-repository pull requests. + + + ## Interact with CodeRabbit reviews {#interact} After CodeRabbit attaches its initial code-review comment to a pull request, you can From 55eb2311a26367c534b3a8d9cb068878308ce85f Mon Sep 17 00:00:00 2001 From: electricplayer <40640596+electricplayer@users.noreply.github.com> Date: Tue, 8 Jul 2025 14:21:56 -0500 Subject: [PATCH 3/3] docs: remove excess bolding Signed-off-by: electricplayer <40640596+electricplayer@users.noreply.github.com> --- docs/guides/code-review-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/code-review-overview.md b/docs/guides/code-review-overview.md index a1505548..32ffdb88 100644 --- a/docs/guides/code-review-overview.md +++ b/docs/guides/code-review-overview.md @@ -48,8 +48,8 @@ perform a code review: CodeRabbit automatically reviews a pull request when **either** of the following statements is true: -- **The pull request is in a public repository.** CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan. -- **The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you.** Only under this condition does CodeRabbit review private-repository pull requests. +- The pull request is in a public repository. CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan. +- The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you. Only under this condition does CodeRabbit review private-repository pull requests.