diff --git a/docs/guides/code-review-overview.md b/docs/guides/code-review-overview.md index cd511c76..32ffdb88 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. @@ -42,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