Skip to content

Commit fbe161f

Browse files
authored
docs: clarify PR review eligibility (#378) (#396)
1 parent f4a00ae commit fbe161f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/guides/code-review-overview.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: An overview of CodeRabbit's core code review features.
44
sidebar_label: Overview
55
---
66

7+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'
8+
79
The central feature of CodeRabbit is its ability to proactively review
810
new pull requests on your code repository.
911

@@ -42,6 +44,15 @@ perform a code review:
4244
- If an open pull request that CodeRabbit has already reviewed gets modified with another
4345
commit, then CodeRabbit performs an incremental review that focuses on the new commit.
4446

47+
### Which pull requests get automatically reviewed {#eligibility}
48+
49+
CodeRabbit automatically reviews a pull request when **either** of the following statements is true:
50+
51+
- 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.
52+
- 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.
53+
54+
<ProPlanNotice />
55+
4556
## Interact with CodeRabbit reviews {#interact}
4657

4758
After CodeRabbit attaches its initial code-review comment to a pull request, you can

0 commit comments

Comments
 (0)