@@ -4,111 +4,111 @@ sidebar_label: FAQs
4
4
description : Frequently asked questions about CodeRabbit.
5
5
---
6
6
7
- ## General
7
+ ### General
8
8
9
- ### How accurate is CodeRabbit's review?
9
+ #### How accurate is CodeRabbit's review?
10
10
11
11
Early adoption results for CodeRabbit have been highly promising, demonstrating
12
12
significant accuracy in code reviews. However, it's crucial to understand that
13
13
AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our
14
14
technology is continuously improving, aiming for the highest possible accuracy
15
15
in reviews.
16
16
17
- ### Which programming languages does CodeRabbit support?
17
+ #### Which programming languages does CodeRabbit support?
18
18
19
- CodeRabbit is designed to work with all programming languages. However, the
19
+ CodeRabbit is designed to work with all programming languages. The
20
20
proficiency of our AI models might vary between languages based on their
21
21
popularity and the public availability of training data.
22
22
23
- ### Does CodeRabbit store my code?
23
+ #### Does CodeRabbit store my code?
24
24
25
- We do not store your code. The code collected at the time of the review is
25
+ We do not store your code. The code repository that is cloned at the time of the review is
26
26
disposed of as soon as the review is complete. During the review, there is
27
27
complete data isolation of the code being reviewed, and no one from CodeRabbit
28
28
or outside has access to the code.
29
29
30
- ### Does CodeRabbit use my proprietary code for training language models?
30
+ #### Does CodeRabbit use my proprietary code for training language models?
31
31
32
32
We train our system only using publicly available datasets. CodeRabbit never
33
33
uses proprietary code from private repositories for training purposes.
34
34
35
- ### Can I switch between different organizations on CodeRabbit?
35
+ #### Can I switch between different organizations on CodeRabbit?
36
36
37
37
Yes, you can switch between different organizations on CodeRabbit. To do so,
38
38
click on the organization name in the top-left corner of the CodeRabbit UI.
39
39
40
40
![ Switch Organizations] ( ./images/cr_support_orgs_light.png#gh-light-mode-only )
41
41
![ Switch Organizations] ( ./images/cr_support_orgs_dark.png#gh-dark-mode-only )
42
42
43
- ### Can a CodeRabbit subscription be used across multiple organizations ?
43
+ #### What Large Language Models does CodeRabbit use ?
44
44
45
- Subscription seats are tied to the specific GitHub/GitLab organization under
46
- which they are purchased and cannot be used under another organization.
45
+ CodeRabbit currently utilizes OpenAI's ` gpt-4-turbo ` and ` gpt-3.5-turbo ` . We're
46
+ researching and testing upcoming LLMs to ensure we're offering the most precise
47
+ reviews possible.
47
48
48
- ### Can CodeRabbit review my existing PRs after integrating it?
49
+ ### Subscription
49
50
50
- CodeRabbit will by default only review new PRs or existing PRs which have a new
51
- commit after the app is installed. You can, however, use the
52
- ` @coderabbitai review ` command on the PR to trigger a review for existing PRs.
51
+ #### Can a CodeRabbit subscription be used across multiple organizations?
53
52
54
- ### Who can install CodeRabbit on the repositories?
55
-
56
- You need to be a GitHub/GitLab admin to add the repositories.
53
+ Subscription seats are tied to the specific GitHub/GitLab organization under
54
+ which they are purchased and cannot be used under another organization.
57
55
58
- ### Do I need my own OpenAI key with CodeRabbit Pro?
56
+ #### Do I need my own OpenAI key with CodeRabbit Pro?
59
57
60
58
OpenAI cost is included as part of the subscription. You don't need to have your
61
59
own OpenAI key.
62
60
63
- ### What Large Language Models does CodeRabbit use ?
61
+ #### How can I add or remove users for my subscription ?
64
62
65
- CodeRabbit currently utilizes OpenAI's ` gpt-4-turbo ` and ` gpt-3.5-turbo ` . We're
66
- researching and testing upcoming LLMs to ensure we're offering the most precise
67
- reviews possible.
63
+ To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
64
+ or remove users as needed.
65
+
66
+ ### Usage and Configuration
67
+
68
+ #### Can CodeRabbit review my existing PRs after integrating it?
69
+
70
+ CodeRabbit will by default only review new PRs or existing PRs which have a new
71
+ commit after the app is installed. You can, however, use the
72
+ ` @coderabbitai review ` command on the PR to trigger a review for existing PRs.
68
73
69
- ### Can I customize CodeRabbit?
74
+ #### Can I customize CodeRabbit?
70
75
71
76
Reviews are customizable. For information, check out our
72
77
[ Customization] ( ../guides/review-instructions.md ) guide.
73
78
74
- ### Can I choose a language other than English for the reviews?
79
+ #### Can I choose a language other than English for the reviews?
75
80
76
81
CodeRabbit supports most widely used languages. You can configure this in the
77
82
repository settings.
78
83
79
- ### What access does CodeRabbit need to my repositories?
84
+ #### What access does CodeRabbit need to my repositories?
80
85
81
86
CodeRabbit requests minimal access to perform code reviews and post comments on
82
87
Pull Requests. On GitHub, it requires read access to metadata, code,
83
88
discussions, and issues, as well as read/write access to pull requests. On
84
89
GitLab, it requires read access to the repository, and the CodeRabbit Bot user
85
90
requires a developer role.
86
91
87
- ### How can I add or remove users for my subscription?
88
-
89
- To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
90
- or remove users as needed.
91
-
92
- ### How can I interact with the CodeRabbit bot?
92
+ #### How can I interact with the CodeRabbit bot?
93
93
94
94
To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
95
95
team members collaborating on pull requests, the bot stays silent by default but
96
96
can be engaged by tagging ** @coderabbitai ** . This feature allows you to provide
97
97
context, generate test cases, or ask for specific code suggestions, all within
98
98
the context of your code lines or entire files.
99
99
100
- ### Can individual developers use CodeRabbit?
100
+ #### Can individual developers use CodeRabbit?
101
101
102
102
Absolutely! Whether you're an individual developer or part of an organization,
103
103
CodeRabbit can be your coding assistant, providing you with invaluable
104
104
suggestions.
105
105
106
- ### Which branches are the pull requests reviewed on?
106
+ #### Which branches are the pull requests reviewed on?
107
107
108
108
CodeRabbit reviews pull requests on the default branch by default. You can
109
109
change this in the repository settings.
110
110
111
- ### CodeRabbit Usage Limits
111
+ #### CodeRabbit Usage Limits
112
112
113
113
There are hourly rate limits for each developer per repository:
114
114
@@ -119,7 +119,13 @@ There are hourly rate limits for each developer per repository:
119
119
In-trial and open-source plans have lower rate limits than the paid plan. In all
120
120
cases, we re-allow further reviews/conversations after a brief timeout.
121
121
122
- ### I can't add CodeRabbit to my GitLab Repositories. What should I do?
122
+ ### Integration
123
+
124
+ #### Who can install CodeRabbit on the repositories?
125
+
126
+ You need to be an admin of the orgnizaation to add the repositories.
127
+
128
+ #### I can't add CodeRabbit to my GitLab Repositories. What should I do?
123
129
124
130
If there are any access restrictions by domain, then you will need to add
125
131
` coderabbit.ai ` as an allowed domain.
0 commit comments