Skip to content

Commit d9249be

Browse files
jmacdotorgjmacdotorg
committed
Add a config template file to the docs.
1 parent 64be92a commit d9249be

File tree

3 files changed

+186
-2
lines changed

3 files changed

+186
-2
lines changed

‎docs/getting-started/configure-coderabbit.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ configuration in a YAML format. You can then copy the configuration to a
3434
:::
3535

3636
You can add a `.coderabbit.yaml` configuration file to the root of your
37-
repositories. Below is a sample YAML file that can be used as a starting point
38-
and changed as needed:
37+
repositories. For a complete sample `.coderabbit.yaml` file which you can add to your repository and update as needed, see [Configuration file template](/reference/yaml-template).
3938

4039
Write your configuration file in the below editor to validate:
4140

‎docs/reference/yaml-template.md

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
---
2+
title: Configuration file template
3+
---
4+
5+
You can use the following template as a basis for a new `.coderabbit.yaml` configuration file at the root level of your repository.
6+
7+
If used as-is as a `.coderabbit.yaml` file, then this template sets the default, recommended values for [all CodeRabbit repository options](/reference/configuration). You can then update the values to best suit your team's code-review needs.
8+
9+
For more information about using a `.coderabbit.yaml` file, see [Add a configuration file](/getting-started/configure-coderabbit).
10+
11+
For a general overview of CodeRabbit configuration, see [Configure CodeRabbit](/guides/configuration-overview).
12+
13+
```yaml
14+
# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json
15+
16+
language: en-US
17+
tone_instructions: ''
18+
early_access: true
19+
enable_free_tier: true
20+
reviews:
21+
profile: chill
22+
request_changes_workflow: false
23+
high_level_summary: true
24+
high_level_summary_placeholder: '@coderabbitai summary'
25+
high_level_summary_in_walkthrough: false
26+
auto_title_placeholder: '@coderabbitai'
27+
auto_title_instructions: ''
28+
review_status: true
29+
commit_status: true
30+
fail_commit_status: false
31+
collapse_walkthrough: false
32+
changed_files_summary: true
33+
sequence_diagrams: true
34+
assess_linked_issues: true
35+
related_issues: true
36+
related_prs: true
37+
suggested_labels: true
38+
auto_apply_labels: false
39+
suggested_reviewers: true
40+
auto_assign_reviewers: false
41+
poem: true
42+
labeling_instructions:
43+
- label: ''
44+
instructions: ''
45+
path_filters: []
46+
path_instructions:
47+
- path: ''
48+
instructions: ''
49+
abort_on_close: true
50+
disable_cache: false
51+
auto_review:
52+
enabled: true
53+
auto_incremental_review: true
54+
ignore_title_keywords: []
55+
labels: []
56+
drafts: false
57+
base_branches: []
58+
finishing_touches:
59+
docstrings:
60+
enabled: true
61+
unit_tests:
62+
enabled: true
63+
tools:
64+
ast-grep:
65+
rule_dirs: []
66+
util_dirs: []
67+
essential_rules: true
68+
packages: []
69+
shellcheck:
70+
enabled: true
71+
ruff:
72+
enabled: true
73+
markdownlint:
74+
enabled: true
75+
github-checks:
76+
enabled: true
77+
timeout_ms: 90000
78+
languagetool:
79+
enabled: true
80+
enabled_rules: []
81+
disabled_rules: []
82+
enabled_categories: []
83+
disabled_categories: []
84+
enabled_only: false
85+
level: default
86+
biome:
87+
enabled: true
88+
hadolint:
89+
enabled: true
90+
swiftlint:
91+
enabled: true
92+
config_file: ''
93+
phpstan:
94+
enabled: true
95+
level: default
96+
golangci-lint:
97+
enabled: true
98+
config_file: ''
99+
yamllint:
100+
enabled: true
101+
gitleaks:
102+
enabled: true
103+
checkov:
104+
enabled: true
105+
detekt:
106+
enabled: true
107+
config_file: ''
108+
eslint:
109+
enabled: true
110+
rubocop:
111+
enabled: true
112+
buf:
113+
enabled: true
114+
regal:
115+
enabled: true
116+
actionlint:
117+
enabled: true
118+
pmd:
119+
enabled: true
120+
config_file: ''
121+
cppcheck:
122+
enabled: true
123+
semgrep:
124+
enabled: true
125+
config_file: ''
126+
circleci:
127+
enabled: true
128+
clippy:
129+
enabled: true
130+
sqlfluff:
131+
enabled: true
132+
prismaLint:
133+
enabled: true
134+
pylint:
135+
enabled: true
136+
oxc:
137+
enabled: true
138+
shopifyThemeCheck:
139+
enabled: true
140+
luacheck:
141+
enabled: true
142+
brakeman:
143+
enabled: true
144+
dotenvLint:
145+
enabled: true
146+
htmlhint: true
147+
enabled: true
148+
config_file: ''
149+
checkmake:
150+
enabled: true
151+
chat:
152+
auto_reply: true
153+
integrations:
154+
jira:
155+
usage: auto
156+
linear:
157+
usage: auto
158+
knowledge_base:
159+
opt_out: false
160+
web_search:
161+
enabled: true
162+
learnings:
163+
scope: auto
164+
issues:
165+
scope: auto
166+
jira:
167+
usage: auto
168+
project_keys: []
169+
linear:
170+
usage: auto
171+
team_keys: []
172+
pull_requests:
173+
scope: auto
174+
code_generation:
175+
docstrings:
176+
language: en-US
177+
path_instructions:
178+
- path: ''
179+
instructions: ''
180+
unit_tests:
181+
path_instructions:
182+
- path: ''
183+
instructions: ''
184+
```

‎sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ const sidebars: SidebarsConfig = {
167167
},
168168
"reference/review-commands",
169169
"reference/configuration",
170+
"reference/yaml-template",
170171
{
171172
type: "category",
172173
label: "Supported tools",

0 commit comments

Comments
 (0)