Skip to content

Commit 6ecf4f1

Browse files
test-commit for GH PR VSCode Ext trial
1 parent 8b590da commit 6ecf4f1

File tree

1 file changed

+147
-0
lines changed

1 file changed

+147
-0
lines changed

docs/faq-special.md

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: FAQs
3+
sidebar_label: FAQs
4+
description: Frequently asked questions about CodeRabbit.
5+
sidebar_position: 9
6+
---
7+
8+
### General
9+
10+
#### How accurate is CodeRabbit's review?
11+
12+
It is ok to change this!
13+
14+
#### Which programming languages does CodeRabbit support?
15+
16+
CodeRabbit FAQ
17+
18+
#### Does CodeRabbit store my code?
19+
20+
We do not store your code. The code repository that is cloned at the time of the review is
21+
disposed of as soon as the review is complete. During the review, there is
22+
complete data isolation of the code being reviewed, and no one from CodeRabbit
23+
or outside has access to the code.
24+
25+
#### Does CodeRabbit use my proprietary code for training language models?
26+
27+
We train our system only using publicly available datasets. CodeRabbit never
28+
uses proprietary code from private repositories for training purposes.
29+
30+
#### Can I switch between different organizations on CodeRabbit?
31+
32+
Yes, you can switch between different organizations on CodeRabbit. To do so,
33+
click on the organization name in the top-left corner of the CodeRabbit UI.
34+
35+
![Switch Organizations](/img/faq/cr_support_orgs_light.png#gh-light-mode-only)
36+
![Switch Organizations](/img/faq/cr_support_orgs_dark.png#gh-dark-mode-only)
37+
38+
#### How does CodeRabbit compare to other AI code generators?
39+
40+
Code reviews remain essential, whether the code is written by a human or a bot.
41+
This is mainly because the perspective of the reviewer differs from that of the
42+
code generator, whether human or machine. This distinction is precisely why
43+
human peer reviews have been effective for so long. While AI-powered
44+
code-generation tools like GitHub Copilot hold immense potential, it's important to recognize that
45+
these generators are still in their early stages and may not be equipped to
46+
auto-generate meaningful code for moderately complex applications.
47+
48+
#### How is CodeRabbit different from other code review tools?
49+
50+
Traditional code review tools excel in linting and static analysis, but they
51+
fall short in providing context-aware, conversational feedback with actionable
52+
suggestions for changes that can be directly committed. On the other hand,
53+
**CodeRabbit** leverages AI to understand the intent behind the code changes and
54+
provide human-like feedback for applying the best practices.
55+
56+
### Subscription
57+
58+
#### Can a CodeRabbit subscription be used across multiple organizations?
59+
60+
Subscription seats are tied to the specific GitHub/GitLab organization under
61+
which they are purchased and cannot be used under another organization.
62+
63+
#### Do I need my own OpenAI key with CodeRabbit Pro?
64+
65+
OpenAI cost is included as part of the subscription. You don't need to have your
66+
own OpenAI key.
67+
68+
#### How can I add or remove users for my subscription?
69+
70+
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
71+
or remove users as needed.
72+
73+
#### How can I skip the trial and move to Pro
74+
75+
To move to Pro, login to CodeRabbit and navigate to the Subscription page.
76+
Click on **End Trial and Start Pro Plan** to end the trial and move to the Pro plan.
77+
78+
### Usage and Configuration
79+
80+
#### Can CodeRabbit review my existing PRs after integrating it?
81+
82+
CodeRabbit will by default only review new PRs or existing PRs which have a new
83+
commit after the app is installed. You can, however, use the
84+
`@coderabbitai review` command on the PR to trigger a review for existing PRs.
85+
86+
#### Can I customize CodeRabbit?
87+
88+
Reviews are customizable. For information, check out our
89+
[Customization](./guides/review-instructions.md) guide.
90+
91+
#### Can I choose a language other than English for the reviews?
92+
93+
CodeRabbit supports most widely used languages. You can configure this in the
94+
repository settings.
95+
96+
#### What access does CodeRabbit need to my repositories?
97+
98+
CodeRabbit requests minimal access to perform code reviews and post comments on
99+
Pull Requests. You can review the permissions requested during the installation process.
100+
101+
#### How can I interact with the CodeRabbit bot?
102+
103+
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
104+
team members collaborating on pull requests, the bot stays silent by default but
105+
can be engaged by tagging **@coderabbitai**. This feature allows you to provide
106+
context, generate test cases, or ask for specific code suggestions, all within
107+
the context of your code lines or entire files.
108+
109+
#### Can individual developers use CodeRabbit?
110+
111+
Absolutely! Whether you're an individual developer or part of an organization,
112+
CodeRabbit can be your coding assistant, providing you with invaluable
113+
suggestions.
114+
115+
#### Which branches are the pull requests reviewed on?
116+
117+
CodeRabbit reviews pull requests on the default branch by default. You can
118+
change this in the repository settings.
119+
120+
#### CodeRabbit Usage Limits
121+
122+
There are hourly rate limits for each developer per repository:
123+
124+
- Number of files reviewed per hour: 200
125+
- Number of reviews : 3 back-to-back reviews followed by 3 reviews/hour
126+
- Number of conversations: 25 back-to-back messages followed by 50 messages/hour
127+
128+
In-trial and open-source plans have lower rate limits than the paid plan. In all
129+
cases, we re-allow further reviews/conversations after a brief timeout.
130+
131+
### Integration
132+
133+
#### Who can install CodeRabbit on the repositories?
134+
135+
You need to be an admin of the organization to add the repositories.
136+
137+
#### I can't add CodeRabbit to my GitLab Repositories. What should I do?
138+
139+
If there are any access restrictions by domain, then you will need to add
140+
`coderabbit.ai` as an allowed domain.
141+
142+
:::tip
143+
144+
If you have further questions or need additional information, please check out
145+
our [Support](./about/support.md) page for more details.
146+
147+
:::

0 commit comments

Comments
 (0)