Skip to content

Update introduction and CodeRabbit documentation #64

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 17, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Update FAQ documentation
  • Loading branch information
hasit committed Jul 17, 2024
commit 9e7d829171fbbf14d91d41c7aae31e22a82a71fe
78 changes: 42 additions & 36 deletions docs/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,111 +4,111 @@ sidebar_label: FAQs
description: Frequently asked questions about CodeRabbit.
---

## General
### General

### How accurate is CodeRabbit's review?
#### How accurate is CodeRabbit's review?

Early adoption results for CodeRabbit have been highly promising, demonstrating
significant accuracy in code reviews. However, it's crucial to understand that
AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our
technology is continuously improving, aiming for the highest possible accuracy
in reviews.

### Which programming languages does CodeRabbit support?
#### Which programming languages does CodeRabbit support?

CodeRabbit is designed to work with all programming languages. However, the
CodeRabbit is designed to work with all programming languages. The
proficiency of our AI models might vary between languages based on their
popularity and the public availability of training data.

### Does CodeRabbit store my code?
#### Does CodeRabbit store my code?

We do not store your code. The code collected at the time of the review is
We do not store your code. The code repository that is cloned at the time of the review is
disposed of as soon as the review is complete. During the review, there is
complete data isolation of the code being reviewed, and no one from CodeRabbit
or outside has access to the code.

### Does CodeRabbit use my proprietary code for training language models?
#### Does CodeRabbit use my proprietary code for training language models?

We train our system only using publicly available datasets. CodeRabbit never
uses proprietary code from private repositories for training purposes.

### Can I switch between different organizations on CodeRabbit?
#### Can I switch between different organizations on CodeRabbit?

Yes, you can switch between different organizations on CodeRabbit. To do so,
click on the organization name in the top-left corner of the CodeRabbit UI.

![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only)
![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only)

### Can a CodeRabbit subscription be used across multiple organizations?
#### What Large Language Models does CodeRabbit use?

Subscription seats are tied to the specific GitHub/GitLab organization under
which they are purchased and cannot be used under another organization.
CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
researching and testing upcoming LLMs to ensure we're offering the most precise
reviews possible.

### Can CodeRabbit review my existing PRs after integrating it?
### Subscription

CodeRabbit will by default only review new PRs or existing PRs which have a new
commit after the app is installed. You can, however, use the
`@coderabbitai review` command on the PR to trigger a review for existing PRs.
#### Can a CodeRabbit subscription be used across multiple organizations?

### Who can install CodeRabbit on the repositories?

You need to be a GitHub/GitLab admin to add the repositories.
Subscription seats are tied to the specific GitHub/GitLab organization under
which they are purchased and cannot be used under another organization.

### Do I need my own OpenAI key with CodeRabbit Pro?
#### Do I need my own OpenAI key with CodeRabbit Pro?

OpenAI cost is included as part of the subscription. You don't need to have your
own OpenAI key.

### What Large Language Models does CodeRabbit use?
#### How can I add or remove users for my subscription?

CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're
researching and testing upcoming LLMs to ensure we're offering the most precise
reviews possible.
To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
or remove users as needed.

### Usage and Configuration

#### Can CodeRabbit review my existing PRs after integrating it?

CodeRabbit will by default only review new PRs or existing PRs which have a new
commit after the app is installed. You can, however, use the
`@coderabbitai review` command on the PR to trigger a review for existing PRs.

### Can I customize CodeRabbit?
#### Can I customize CodeRabbit?

Reviews are customizable. For information, check out our
[Customization](../guides/review-instructions.md) guide.

### Can I choose a language other than English for the reviews?
#### Can I choose a language other than English for the reviews?

CodeRabbit supports most widely used languages. You can configure this in the
repository settings.

### What access does CodeRabbit need to my repositories?
#### What access does CodeRabbit need to my repositories?

CodeRabbit requests minimal access to perform code reviews and post comments on
Pull Requests. On GitHub, it requires read access to metadata, code,
discussions, and issues, as well as read/write access to pull requests. On
GitLab, it requires read access to the repository, and the CodeRabbit Bot user
requires a developer role.

### How can I add or remove users for my subscription?

To manage users, log in to CodeRabbit and navigate to subscriptions. You can add
or remove users as needed.

### How can I interact with the CodeRabbit bot?
#### How can I interact with the CodeRabbit bot?

To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are
team members collaborating on pull requests, the bot stays silent by default but
can be engaged by tagging **@coderabbitai**. This feature allows you to provide
context, generate test cases, or ask for specific code suggestions, all within
the context of your code lines or entire files.

### Can individual developers use CodeRabbit?
#### Can individual developers use CodeRabbit?

Absolutely! Whether you're an individual developer or part of an organization,
CodeRabbit can be your coding assistant, providing you with invaluable
suggestions.

### Which branches are the pull requests reviewed on?
#### Which branches are the pull requests reviewed on?

CodeRabbit reviews pull requests on the default branch by default. You can
change this in the repository settings.

### CodeRabbit Usage Limits
#### CodeRabbit Usage Limits

There are hourly rate limits for each developer per repository:

Expand All @@ -119,7 +119,13 @@ There are hourly rate limits for each developer per repository:
In-trial and open-source plans have lower rate limits than the paid plan. In all
cases, we re-allow further reviews/conversations after a brief timeout.

### I can't add CodeRabbit to my GitLab Repositories. What should I do?
### Integration

#### Who can install CodeRabbit on the repositories?

You need to be an admin of the orgnizaation to add the repositories.

#### I can't add CodeRabbit to my GitLab Repositories. What should I do?

If there are any access restrictions by domain, then you will need to add
`coderabbit.ai` as an allowed domain.
Expand Down