-
Notifications
You must be signed in to change notification settings - Fork 39
docs: clarify PR review eligibility (#378) #396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Now that we're using full sentences, this looks like way too much bolding, heh. Let's un-bold the bold text from both of these bullets and I think we're good. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changed |
||
|
||
<ProPlanNotice /> | ||
|
||
## Interact with CodeRabbit reviews {#interact} | ||
|
||
After CodeRabbit attaches its initial code-review comment to a pull request, you can | ||
|
Uh oh!
There was an error while loading. Please reload this page.