Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify PR review eligibility (#378) #396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/guides/code-review-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

<ProPlanNotice />

## Automatically review pull requests {#review}

After you [integrate CodeRabbit with your repository](/platforms), CodeRabbit proceeds
Expand Down