You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/configuration-overview.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -40,11 +40,11 @@ If you want to apply separate CodeRabbit configuration to your organization's di
40
40
manage repository-specific CodeRabbit settings in two ways:
41
41
42
42
- Use the CodeRabbit web interface.
43
-
- Add a `coderabbit.yaml` file to the top level of your repository.
43
+
- Add a `.coderabbit.yaml` file to the top level of your repository.
44
44
45
45
For more information, see [Set your repository preferences](/guides/repository-settings).
46
46
47
-
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
47
+
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
Copy file name to clipboardExpand all lines: docs/guides/initial-configuration.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ the key settings described by this page can help you tune the behavior of
18
18
CodeRabbit for the specific needs of your team. You can use this guide when initially setting up your organization and repositories with CodeRabbit, or you can return to it after using CodeRabbit
19
19
for a while, when you feel ready to customize its behavior.
20
20
21
-
Each section in the guide links to specific entries in the configuration reference. Each entry in the linked reference specifies the location of its configuration setting, in either the CodeRabbit web UI or your `coderabbit.yaml` file.
21
+
Each section in the guide links to specific entries in the configuration reference. Each entry in the linked reference specifies the location of its configuration setting, in either the CodeRabbit web UI or your `.coderabbit.yaml` file.
22
22
23
23
## General settings {#general}
24
24
@@ -120,7 +120,7 @@ For an overview about using path-based instructions in CodeRabbit, see [Path-bas
120
120
121
121
If your repository contains files or locations that CodeRabbit should disregard when preparing code reviews—or you want CodeRabbit to limit its consideration to only certain files—then you can define one or more _path filters_. Adding path filters to a large repository containing a lot of data, generated files, or other non-code content can let CodeRabbit work faster.
122
122
123
-
For example, the following `coderabbit.yaml` excerpt instructs CodeRabbit to take review context only the contents of directories named `src/` in your repository, while disregarding any individual files with `.bin` or `.csv` extensions.
123
+
For example, the following `.coderabbit.yaml` excerpt instructs CodeRabbit to take review context only the contents of directories named `src/` in your repository, while disregarding any individual files with `.bin` or `.csv` extensions.
124
124
125
125
```yaml
126
126
path_filters:
@@ -135,7 +135,7 @@ For more information, see [Path filters](/reference/configuration#path-filters)
135
135
136
136
You can set _path instructions_ that provide CodeRabbit with additional review instructions for various files or locations in your repository. Each path instruction specifies a path specification and a set of instructions, the latter of which you express using natural language.
137
137
138
-
For example, to give CodeRabbit review instructions specific to JavaScript and TypeScript files, you can add a section like this to your repository's `coderabbit.yaml` file:
138
+
For example, to give CodeRabbit review instructions specific to JavaScript and TypeScript files, you can add a section like this to your repository's `.coderabbit.yaml` file:
139
139
140
140
```yaml
141
141
path_instructions:
@@ -189,7 +189,7 @@ CodeRabbit has access to dozens of industry-standard open-source tools to help i
189
189
190
190
By default, CodeRabbit considers every tool available to it during code reviews. If you want CodeRabbit to disregard certain tools, then you can disable them.
191
191
192
-
Several tools that CodeRabbit uses also allow you to specify a path to a tool-specific configuration file in your repository. For example, the following `coderabbit.yaml` excerpt directs CodeRabbit to use configuration files in the repository's `/pmd-config` directory when using the `pmd` tool:
192
+
Several tools that CodeRabbit uses also allow you to specify a path to a tool-specific configuration file in your repository. For example, the following `.coderabbit.yaml` excerpt directs CodeRabbit to use configuration files in the repository's `/pmd-config` directory when using the `pmd` tool:
Copy file name to clipboardExpand all lines: docs/guides/repository-settings.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,14 @@ Git repository. For a general overview of configuring CodeRabbit, see [Configure
11
11
CodeRabbit provides two ways to manage its code-review behavior with each of your organization's repositories:
12
12
13
13
1. View or modify your per-repository settings using the CodeRabbit web interface.
14
-
1. Add a `coderabbit.yaml` file to your repository.
14
+
1. Add a `.coderabbit.yaml` file to your repository.
15
15
16
-
Any settings that you define in the `coderabbit.yaml` file take precedence over
16
+
Any settings that you define in the `.coderabbit.yaml` file take precedence over
17
17
settings defined by the web interface. If your repository doesn't have a
18
-
`coderabbit.yaml` file, then CodeRabbit applies only the settings from the web
18
+
`.coderabbit.yaml` file, then CodeRabbit applies only the settings from the web
19
19
interface.
20
20
21
-
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
21
+
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `.coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
22
22
23
23
## Browse and modify your settings using the web interface {#modify}
24
24
@@ -30,9 +30,9 @@ To view of modify your repsository settings using the CodeRabbit web interface,
30
30
1. If the **Use Organization Settings** toggle is on, then click it to turn it off. If you leave it on, then CodeRabbit applies the settings you have set through [the organization-configuration page](/guide/organization-settings) to this repository.
31
31
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.
32
32
33
-
## Configure your repository with `coderabbit.yaml`
33
+
## Configure your repository with `.coderabbit.yaml`
34
34
35
-
For more information about creating and updating a `coderabbit.yaml` file in
35
+
For more information about creating and updating a `.coderabbit.yaml` file in
36
36
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).
Copy file name to clipboardExpand all lines: docs/guides/setup-best-practices.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -66,18 +66,18 @@ CodeRabbit gives you two ways to configure how it works with your team's reposit
66
66
67
67
- The **Organization Settings** and **Repositories** pages of [the
68
68
CodeRabbit web interface](https://app.coderabbit.ai/login)
69
-
- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
69
+
- A [`.coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
70
70
71
71
The web interface lets you set up your organization's code review
72
72
preferences rapidly, and can help you get familiar with CodeRabbit configuration options.
73
73
74
-
We recommend adding a `coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:
74
+
We recommend adding a `.coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:
75
75
76
76
- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
77
77
- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
78
78
- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
79
79
80
-
Repository-level settings defined by a `coderabbit.yaml` take precedence over the
80
+
Repository-level settings defined by a `.coderabbit.yaml` take precedence over the
81
81
settings defined for that repository or for your organization using the CodeRabbit web interface.
82
82
83
83
For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).
@@ -94,7 +94,7 @@ Reducing the number of contextual files that CodeRabbit needs to read and analyz
94
94
when preparing a code review can help make its code reviews faster.
95
95
96
96
You can define path filters using the CodeRabbit
97
-
web interface, or with [a `coderabbit.yaml` file](/getting-started/configure-coderabbit/).
97
+
web interface, or with [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).
98
98
99
99
### Trust the defaults {#defaults}
100
100
@@ -106,7 +106,7 @@ CodeRabbit gives you control over a number of its core code-review features, let
106
106
tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
107
107
-**Knowledge base**: CodeRabbit [knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.
108
108
109
-
You can configure your use of the above features using the CodeRabbit web interface, or [a `coderabbit.yaml` file](/getting-started/configure-coderabbit/).
109
+
You can configure your use of the above features using the CodeRabbit web interface, or [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).
110
110
111
111
### Write specific CI/CD error messages {#pipeline}
0 commit comments