Skip to content

Add code_guidelines to the sample YAML. #416

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 2 commits into from
Jun 25, 2025
Merged
Changes from all commits
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
43 changes: 23 additions & 20 deletions docs/reference/yaml-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ For a general overview of CodeRabbit configuration, see [Configure CodeRabbit](/
# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json

language: en-US
tone_instructions: ''
tone_instructions: ""
early_access: true
enable_free_tier: true
reviews:
profile: chill
request_changes_workflow: false
high_level_summary: true
high_level_summary_placeholder: '@coderabbitai summary'
high_level_summary_placeholder: "@coderabbitai summary"
high_level_summary_in_walkthrough: false
auto_title_placeholder: '@coderabbitai'
auto_title_instructions: ''
auto_title_placeholder: "@coderabbitai"
auto_title_instructions: ""
review_status: true
commit_status: true
fail_commit_status: false
Expand All @@ -40,12 +40,12 @@ reviews:
auto_assign_reviewers: false
poem: true
labeling_instructions:
- label: ''
instructions: ''
- label: ""
instructions: ""
path_filters: []
path_instructions:
- path: ''
instructions: ''
- path: ""
instructions: ""
abort_on_close: true
disable_cache: false
auto_review:
Expand Down Expand Up @@ -89,13 +89,13 @@ reviews:
enabled: true
swiftlint:
enabled: true
config_file: ''
config_file: ""
phpstan:
enabled: true
level: default
golangci-lint:
enabled: true
config_file: ''
config_file: ""
yamllint:
enabled: true
gitleaks:
Expand All @@ -104,7 +104,7 @@ reviews:
enabled: true
detekt:
enabled: true
config_file: ''
config_file: ""
eslint:
enabled: true
rubocop:
Expand All @@ -117,12 +117,12 @@ reviews:
enabled: true
pmd:
enabled: true
config_file: ''
config_file: ""
cppcheck:
enabled: true
semgrep:
enabled: true
config_file: ''
config_file: ""
circleci:
enabled: true
clippy:
Expand All @@ -142,10 +142,10 @@ reviews:
brakeman:
enabled: true
dotenvLint:
enabled: true
htmlhint: true
enabled: true
config_file: ''
htmlhint:
enabled: true
config_file: ""
checkmake:
enabled: true
chat:
Expand All @@ -159,6 +159,9 @@ knowledge_base:
opt_out: false
web_search:
enabled: true
code_guidelines:
enabled: true
filePatterns: []
learnings:
scope: auto
issues:
Expand All @@ -175,10 +178,10 @@ code_generation:
docstrings:
language: en-US
path_instructions:
- path: ''
instructions: ''
- path: ""
instructions: ""
unit_tests:
path_instructions:
- path: ''
instructions: ''
- path: ""
instructions: ""
```