Skip to content

Commit da7cada

Browse files
authored
Add code_guidelines to the sample YAML. (#416)
* Add `code_guidelines` to the sample YAML. * Fix an earlier typo
1 parent 4e961df commit da7cada

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

docs/reference/yaml-template.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ For a general overview of CodeRabbit configuration, see [Configure CodeRabbit](/
1414
# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json
1515

1616
language: en-US
17-
tone_instructions: ''
17+
tone_instructions: ""
1818
early_access: true
1919
enable_free_tier: true
2020
reviews:
2121
profile: chill
2222
request_changes_workflow: false
2323
high_level_summary: true
24-
high_level_summary_placeholder: '@coderabbitai summary'
24+
high_level_summary_placeholder: "@coderabbitai summary"
2525
high_level_summary_in_walkthrough: false
26-
auto_title_placeholder: '@coderabbitai'
27-
auto_title_instructions: ''
26+
auto_title_placeholder: "@coderabbitai"
27+
auto_title_instructions: ""
2828
review_status: true
2929
commit_status: true
3030
fail_commit_status: false
@@ -40,12 +40,12 @@ reviews:
4040
auto_assign_reviewers: false
4141
poem: true
4242
labeling_instructions:
43-
- label: ''
44-
instructions: ''
43+
- label: ""
44+
instructions: ""
4545
path_filters: []
4646
path_instructions:
47-
- path: ''
48-
instructions: ''
47+
- path: ""
48+
instructions: ""
4949
abort_on_close: true
5050
disable_cache: false
5151
auto_review:
@@ -89,13 +89,13 @@ reviews:
8989
enabled: true
9090
swiftlint:
9191
enabled: true
92-
config_file: ''
92+
config_file: ""
9393
phpstan:
9494
enabled: true
9595
level: default
9696
golangci-lint:
9797
enabled: true
98-
config_file: ''
98+
config_file: ""
9999
yamllint:
100100
enabled: true
101101
gitleaks:
@@ -104,7 +104,7 @@ reviews:
104104
enabled: true
105105
detekt:
106106
enabled: true
107-
config_file: ''
107+
config_file: ""
108108
eslint:
109109
enabled: true
110110
rubocop:
@@ -117,12 +117,12 @@ reviews:
117117
enabled: true
118118
pmd:
119119
enabled: true
120-
config_file: ''
120+
config_file: ""
121121
cppcheck:
122122
enabled: true
123123
semgrep:
124124
enabled: true
125-
config_file: ''
125+
config_file: ""
126126
circleci:
127127
enabled: true
128128
clippy:
@@ -142,10 +142,10 @@ reviews:
142142
brakeman:
143143
enabled: true
144144
dotenvLint:
145-
enabled: true
146-
htmlhint: true
147145
enabled: true
148-
config_file: ''
146+
htmlhint:
147+
enabled: true
148+
config_file: ""
149149
checkmake:
150150
enabled: true
151151
chat:
@@ -159,6 +159,9 @@ knowledge_base:
159159
opt_out: false
160160
web_search:
161161
enabled: true
162+
code_guidelines:
163+
enabled: true
164+
filePatterns: []
162165
learnings:
163166
scope: auto
164167
issues:
@@ -175,10 +178,10 @@ code_generation:
175178
docstrings:
176179
language: en-US
177180
path_instructions:
178-
- path: ''
179-
instructions: ''
181+
- path: ""
182+
instructions: ""
180183
unit_tests:
181184
path_instructions:
182-
- path: ''
183-
instructions: ''
185+
- path: ""
186+
instructions: ""
184187
```

0 commit comments

Comments
 (0)