Skip to content

Add new configuration guides and reference material. #405

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 19 commits into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
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
Tweaks
  • Loading branch information
jmacdotorg committed Jun 24, 2025
commit a245c0902dbb0e01b4e673d6455000c54884214f
2 changes: 1 addition & 1 deletion docs/guides/configuration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ For more information, see [Set your organization preferences](/guides/organizati
If you want to apply separate CodeRabbit configuration to your organization's different repositories, then you can
manage repository-specific CodeRabbit settings in two ways:

- Use the CodeRabbit web interface.
- Add a `.coderabbit.yaml` file to the top level of your repository.
- Use the CodeRabbit web interface.

For more information, see [Set your repository preferences](/guides/repository-settings).

Expand Down
57 changes: 27 additions & 30 deletions docs/guides/initial-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,9 @@ CodeRabbit is aware of nitpickier output from the linters and other tools that i

For more information, see [Profile](/reference/configuration#profile) in the configuration reference.

### Configure pull request approval {#request-changes}

By default, CodeRabbit doesn't mark pull requests as approved after any code review, even if CodeRabbit doesn't have any further significant changes to suggest. This leaves the job of formal pull request approval entirely up to human reviewers.

If you want to allow CodeRabbit to mark pull requests as approved, then you can enable the _request changes workflow_ setting. If you do, then CodeRabbit can approve pull requests after it reviewed a pull request and had all of its comments resolved.

This can be useful if you have a workflow that requires several reviewers to approve a pull request before anyone can merge it. For example, if you have configured your repository on your Git platform to require two approvals for any pull request, then activating this CodeRabbit setting lets you merge a pull request after approval from CodeRabbit plus one human reviewer. This can help reduce your team's code-review load.

:::note
We recommend a policy of always requiring the approval of at least one human reviewer, even if you allow CodeRabbit to approve pull requests. As with an generative AI technology, CodeRabbit works best as a helpful partner to your team, and not as a replacement for human expertise or judgment.
:::

For more information, see [Request Changes Workflow](/reference/configuration#request-changes-workflow) in the configuration reference.

### Configure chat-based issue creation {#chat-issues}

You can [ask CodeRabbit to create issues for you](https://docs.coderabbit.ai/guides/issue-creation) in the comments of a pull request that it's reviewing.

If you have integrated CodeRabbit with Jira or Linear, then you can tune this behavior a little more, restricting this feature to private repositories—the default setting—or disabling it entirely.

For more information, see [Integrations](/reference/configuration#integrations) in the configuration reference.

### Configure learnings {#learnings}

You can teach CodeRabbit your team's review preferences by [stating them in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these these preferences, and applies them to subsequent code reviews in the same repository.
By default, CodeRabbit learns your team's review preferences by letting you [teach it your preferences in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these preferences, and applies them to subsequent code reviews in the same repository.

If you don't want this feature, you can disable it. For more information, see [Learnings](/reference/configuration#learnings) in the configuration reference.

Expand Down Expand Up @@ -139,13 +117,8 @@ For example, to give CodeRabbit review instructions specific to JavaScript and T

```yaml
path_instructions:
- path: `src/**/*.{ts,tsx,js}`
instructions:
- Review the React.js, TypeScript, JavaScript code for best practices
- Check for common security vulnerabilities such as:
- SQL Injection
- Insecure dependencies
- Sensitive data exposure
- path: `src/**/*.{ts,tsx,js}`
instructions: "Review the React.js, TypeScript, JavaScript code for best practices. Check for common security vulnerabilities, such as SQL injection, insecure dependencies, and sensitive data exposure."
```

For more information, see [Path instructions](/reference/configuration#path-instructions) in the configuration reference.
Expand Down Expand Up @@ -201,6 +174,30 @@ reviews:

For more information, see [Tools](/reference/configuration#tools) in the configuration reference.

## Other code review settings {#other}

### Configure pull request approval {#request-changes}

By default, CodeRabbit doesn't mark pull requests as approved after any code review, even if CodeRabbit doesn't have any further significant changes to suggest. This leaves the job of formal pull request approval entirely up to human reviewers.

If you want to allow CodeRabbit to mark pull requests as approved, then you can enable the _request changes workflow_ setting. If you do, then CodeRabbit can approve pull requests after it reviewed a pull request and had all of its comments resolved.

This can be useful if you have a workflow that requires several reviewers to approve a pull request before anyone can merge it. For example, if you have configured your repository on your Git platform to require two approvals for any pull request, then activating this CodeRabbit setting lets you merge a pull request after approval from CodeRabbit plus one human reviewer. This can help reduce your team's code-review load.

:::note
We recommend a policy of always requiring the approval of at least one human reviewer, even if you allow CodeRabbit to approve pull requests. As with an generative AI technology, CodeRabbit works best as a helpful partner to your team, and not as a replacement for human expertise or judgment.
:::

For more information, see [Request Changes Workflow](/reference/configuration#request-changes-workflow) in the configuration reference.

### Configure chat-based issue creation {#chat-issues}

You can [ask CodeRabbit to create issues for you](https://docs.coderabbit.ai/guides/issue-creation) in the comments of a pull request that it's reviewing.

If you have integrated CodeRabbit with Jira or Linear, then you can tune this behavior a little more, restricting this feature to private repositories—the default setting—or disabling it entirely.

For more information, see [Integrations](/reference/configuration#integrations) in the configuration reference.

## What's next {#whats-next}

- [Setup and configuration best practices](/guides/setup-best-practices)
20 changes: 13 additions & 7 deletions docs/guides/organization-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ For a general overview of configuring CodeRabbit, see [Configure CodeRabbit](/gu

## About organization settings {#about}

You can use the CodeRabbit web interface to set the default CodeRabbit configuration
for all Git repositories associated with your organization. There are two reasons
to review and set your organizational settings:
You can use the CodeRabbit web interface to set a CodeRabbit configuration
for all Git repositories associated with your organization.

- When you give CodeRabbit access to a new repository, CodeRabbit applies all of your
organizational settings to that repository as defaults.
- Some settings, such as [Data retention](/reference/configuration#data-retention), apply only at the organizational level, with
no per-repository equivalent.
You

:::note
Some settings, such as [Data retention](/reference/configuration#data-retention), apply only at the organizational level, with no per-repository equivalent.
:::

## Browse and modify your organization settings {#modify}

Expand All @@ -28,6 +28,12 @@ To view or modify your organizational settings, follow these steps:
1. In the sidebar, click **Organization Settings** > **Configuration**.
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.

## Apply organization settings to your repositories {#repositories}

To apply your organizational settings to a repository, follow these steps:

1.

## What's next {#whats-next}

- [Initial configuration guide](/guides/initial-configuration)
6 changes: 3 additions & 3 deletions docs/guides/repository-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Git repository. For a general overview of configuring CodeRabbit, see [Configure

CodeRabbit provides two ways to manage its code-review behavior with each of your organization's repositories:

1. View or modify your per-repository settings using the CodeRabbit web interface.
1. Add a `.coderabbit.yaml` file to your repository.
- Add a `.coderabbit.yaml` file to your repository.
- View or modify your per-repository settings using the CodeRabbit web interface.

Any settings that you define in the `.coderabbit.yaml` file take precedence over
settings defined by the web interface. If your repository doesn't have a
Expand All @@ -22,7 +22,7 @@ While the web interface provides and easier way to explore the available configu

## Browse and modify your settings using the web interface {#modify}

To view of modify your repsository settings using the CodeRabbit web interface, follow these steps:
To view or modify your repository settings using the CodeRabbit web interface, follow these steps:

1. Visit [the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories).
1. In the sidebar, click **Repositories**.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ For more information about payment tiers and features, see [Pricing](https://www
</Tabs>

Defines the written language that CodeRabbit presents its review comments in. Defaults
to American English.
to U.S. English.

### Tone Instructions

Expand Down Expand Up @@ -606,7 +606,7 @@ Activate this setting to disallow CodeRabbit from caching your repository's code
When caching is allowed, then CodeRabbit stores a cache of code and metadata from
your repostory for up to seven days after its most recent code review. This cache
lets CodeRabbit save time and effort in between subsquent reviews of the same
repository.
repository. For more information, see [Caching](/reference/caching/).

We recommend leaving this setting off, which allows caching, and can speed up
code reviews. For more information, see
Expand Down