docs: clarify PR review eligibility (#378) #396
Conversation
Signed-off-by: electricplayer <40640596+electricplayer@users.noreply.github.com>
WalkthroughThe documentation was updated to add a "Review eligibility" section, explaining when CodeRabbit will review pull requests for public and private repositories. The section also includes an embedded Changes
Poem
Impact Analysis[ℹ️ LOW 🔄 Impacts behavior] Clarification of automatic pull request review eligibility in documentationThe documentation now clearly explains which pull requests are automatically reviewed by CodeRabbit, specifying the differences between public and private repositories and the requirements for Pro plan users. This helps users better understand when to expect automatic reviews, but does not alter any product functionality or user workflows. Review the updated documentation section to ensure the eligibility criteria are accurately described and the ProPlanNotice component displays as intended. Verify clarity and correctness from a user's perspective. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
docs/guides/code-review-overview.md
Outdated
| @@ -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} | |||
There was a problem hiding this comment.
Since many of our headers start with imperative verbs, I am cautious about starting headers with "Review" as a noun like this, since it's ambiguous. This could be read as "Here is how you review something for eligibility."
How about moving this into a level-three section, after the "Events that trigger automated reviews" section? And retitling it "Which pull requests get automatically reviewed".
docs/guides/code-review-overview.md
Outdated
|
|
||
| CodeRabbit will review your pull request if one of the following is true: | ||
|
|
||
| - **Public repositories:** CodeRabbit reviews every PR by default. |
There was a problem hiding this comment.
This needs a reword for clarity. How about:
"The pull request is part of a public repository. CodeRabbit automatically reviews pull requests against the main branch of your public repositories, by default. This feature is available to all subscription tiers, including the free plan."
Part of my nitpick here is that the list lead-in makes us expect a list or true-or-false statement, but "Public repositories" isn't really a statement that can be true or false. The bolded sentence I suggest above is true-or-false, though. Make sense?
docs/guides/code-review-overview.md
Outdated
| 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. |
There was a problem hiding this comment.
Apply the same strategy as above to this one, too. (And let's spell out "pull request".)
There was a problem hiding this comment.
Wrote it as: The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you
Signed-off-by: electricplayer <40640596+electricplayer@users.noreply.github.com>
| 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.
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.
Adds "Review eligibility" section to clarify which PRs CodeRabbit reviews.
Tackles #378