- Notifications
You must be signed in to change notification settings - Fork45
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
jmacdotorg merged 3 commits intocoderabbitai:mainfromhardikkgupta:docs/clarify-review-eligibilityJul 9, 2025
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
11 changes: 11 additions & 0 deletionsdocs/guides/code-review-overview.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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' | ||
jmacdotorg marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
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. | ||
<ProPlanNotice /> | ||
## Interact with CodeRabbit reviews {#interact} | ||
After CodeRabbit attaches its initial code-review comment to a pull request, you can | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.