-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy path.coderabbit.yaml
More file actions
728 lines (600 loc) · 29.4 KB
/
.coderabbit.yaml
File metadata and controls
728 lines (600 loc) · 29.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json
# CodeRabbit Configuration Template
# Complete reference: https://docs.coderabbit.ai/reference/configuration
# Copy this file to .coderabbit.yaml in your repository root
# =============================================================================
# GLOBAL SETTINGS
# These settings apply to your entire CodeRabbit configuration
# =============================================================================
# Set the language for reviews by using the corresponding ISO language code.
# Options: de, de-DE, de-AT, de-CH, en, en-US, en-AU, en-GB, en-CA, en-NZ, en-ZA, es, es-AR, fr, fr-CA, fr-CH, fr-BE, nl, nl-BE, pt-AO, pt, pt-BR, pt-MZ, pt-PT, ar, ast-ES, ast, be-BY, be, br-FR, br, ca-ES, ca, ca-ES-valencia, ca-ES-balear, da-DK, da, de-DE-x-simple-language, el-GR, el, eo, fa, ga-IE, ga, gl-ES, gl, it, ja-JP, ja, km-KH, km, ko-KR, ko, pl-PL, pl, ro-RO, ro, ru-RU, ru, sk-SK, sk, sl-SI, sl, sv, ta-IN, ta, tl-PH, tl, tr, uk-UA, uk, zh-CN, zh, crh-UA, crh, cs-CZ, cs, nb, no, nl-NL, de-DE-x-simple-language-DE, es-ES, it-IT, fa-IR, sv-SE, de-LU, fr-FR, bg-BG, bg, he-IL, he, hi-IN, hi, vi-VN, vi, th-TH, th, bn-BD, bn
# Default: "en-US"
language: "en-US"
# Set the tone of reviews and chat. Example: 'You must use talk like Mr. T. I pity the fool who doesn't!'
# Default: ""
tone_instructions: ""
# Enable early-access features.
# Default: false
early_access: false
# Enable free tier features for users not on a paid plan.
# Default: true
enable_free_tier: true
# =============================================================================
# REVIEWS
# Settings related to reviews.
# =============================================================================
# Settings related to reviews.
# Default: {}
reviews:
# Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky.
# Options: chill, assertive
# Default: "chill"
profile: "assertive"
# Approve the review once CodeRabbit’s comments are resolved and no pre-merge checks are in an error state. Note: In GitLab, all discussions must be resolved.
# Default: false
request_changes_workflow: false
# Generate a high level summary of the changes in the PR/MR description.
# Default: true
high_level_summary: true
# Placeholder in the PR/MR description that gets replaced with the high level summary.
# Default: "@coderabbitai summary"
high_level_summary_placeholder: "@coderabbitai summary"
# Include the high level summary in the walkthrough comment.
# Default: false
high_level_summary_in_walkthrough: false
# Add this keyword in the PR/MR title to auto-generate the title.
# Default: "@coderabbitai"
auto_title_placeholder: "@coderabbitai"
# Auto Title Instructions - Custom instructions for auto-generating the PR/MR title.
# Default: ""
auto_title_instructions: ""
# Post review details on each review. Additionally, post a review status when a review is skipped in certain cases.
# Default: true
review_status: true
# Set the commit status to 'pending' when the review is in progress and 'success' when it is complete.
# Default: true
commit_status: true
# Set the commit status to 'failure' when the PR cannot be reviewed by CodeRabbit for any reason.
# Default: false
fail_commit_status: false
# Generate walkthrough in a markdown collapsible section.
# Default: false
collapse_walkthrough: false
# Generate a summary of the changed files in the walkthrough.
# Default: true
changed_files_summary: true
# Generate sequence diagrams in the walkthrough.
# Default: true
sequence_diagrams: true
# Estimate the code review effort in the walkthrough.
# Default: true
estimate_code_review_effort: true
# Generate an assessment of how well the changes address the linked issues in the walkthrough.
# Default: true
assess_linked_issues: true
# Include possibly related issues in the walkthrough.
# Default: true
related_issues: true
# Related PRs - Include possibly related pull requests in the walkthrough.
# Default: true
related_prs: true
# Suggest labels based on the changes in the pull request in the walkthrough.
# Default: true
suggested_labels: true
# Automatically apply the suggested labels to the PR/MR.
# Default: false
auto_apply_labels: false
# Suggest reviewers based on the changes in the pull request in the walkthrough.
# Default: true
suggested_reviewers: true
# Automatically assign suggested reviewers to the pull request
# Default: false
auto_assign_reviewers: false
# Generate a poem in the walkthrough comment.
# Default: true
poem: false
# Labeling Instructions - Provide guidelines for suggesting labels for the PR/MR. When specific labels or instructions are provided, only those labels are considered, though previous examples are still used to inform the suggestions. If no such labels are provided, suggestions are based solely on previous PR/MRs.
# Default: []
labeling_instructions: []
# Specify file patterns to include or exclude in a review using glob patterns (e.g., !dist/**, src/**). These patterns also apply to 'git sparse-checkout', including specified patterns and ignoring excluded ones (starting with '!') when cloning the repository.
# Default: []
path_filters: ["!stubs/**"]
# Path Instructions - Provide specific additional guidelines for code review based on file paths.
# Default: []
path_instructions: []
# Abort the in-progress review if the pull request is closed or merged.
# Default: true
abort_on_close: true
# Disable caching of code and dependencies. This will force CodeRabbit to download the code and dependencies fresh from the repository each time.
# Default: false
disable_cache: false
# Configuration for auto review
# Default: {}
auto_review:
# Automatic Review - Automatic code review
# Default: true
enabled: true
# Automatic Incremental Review - Automatic incremental code review on each push
# Default: true
auto_incremental_review: true
# Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive).
# Default: []
ignore_title_keywords: []
# List of labels to control which PRs/MRs to review. Labels starting with '!' are negative matches. Examples: ['bug', 'feature'] - reviews PRs with 'bug' OR 'feature' label. ['!wip'] - reviews all PRs except those with 'wip' label. ['bug', '!wip'] - reviews PRs with 'bug' label but not if they have 'wip' label.
# Default: []
labels: []
# Review draft PRs/MRs.
# Default: false
drafts: false
# Base branches (other than the default branch) to review. Accepts regex patterns. Use '.*' to match all branches.
# Default: []
base_branches: [.*]
# Ignore reviewing pull requests by these usernames. These should match the Git platform usernames exactly, not the email addresses.
# Default: []
ignore_usernames: []
# Configuration for finishing touches
# Default: {}
finishing_touches:
# Docstrings - Options for generating Docstrings for your PRs/MRs.
# Default: {}
docstrings:
# Docstrings - Allow CodeRabbit to generate docstrings for PRs/MRs.
# Default: true
enabled: true
# Unit Tests - Options for generating unit tests for your PRs/MRs.
# Default: {}
unit_tests:
# Unit Tests - Allow CodeRabbit to generate unit tests for PRs/MRs.
# Default: true
enabled: true
# Configuration for pre merge checks
# Default: {}
pre_merge_checks:
# Docstring Coverage - Checks if the code has sufficient docstrings.
# Default: {}
docstrings:
# Mode - Determines how strictly the docstring coverage check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.
# Options: off, warning, error
# Default: "warning"
mode: "warning"
# Percentage threshold for docstring coverage check.
# Default: 80
threshold: 80
# Title Check - Checks if the pull request title is appropriate and follows best practices.
# Default: {}
title:
# Mode - Determines how strictly the title check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.
# Options: off, warning, error
# Default: "warning"
mode: "warning"
# Requirements - Requirements for the pull request title. Example: 'Title should be concise and descriptive, ideally under 50 characters.'
# Default: ""
requirements: ""
# Description Check - Checks if the pull request description is appropriate and follows best practices.
# Default: {}
description:
# Mode - Determines how strictly the description check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.
# Options: off, warning, error
# Default: "warning"
mode: "warning"
# Linked Issue Assessment - Checks if the pull request addresses the linked issues. Generate an assessment of how well the changes address the linked issues.
# Default: {}
issue_assessment:
# Mode - Determines how strictly the issue assessment check is enforced. Warning will only generate a warning and does not require the user to resolve the check. Error requires the user to resolve issues before merging the pull request. If set to error and the request changes workflow is enabled, the pull request will be blocked until the issues are resolved.
# Options: off, warning, error
# Default: "warning"
mode: "warning"
# Custom Pre-merge Checks - Add unique checks to enforce your team's standards before merging a pull request. Each check must have a unique name (up to 50 characters) and clear instructions (up to 10000 characters). Use these to automatically verify coding, security, documentation, or business rules and maintain code quality.
# Default: []
custom_checks: []
# Tools that provide additional context to code reviews.
# Default: {}
tools:
# Enable ast-grep - ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. - v0.38.6
# Default: {}
ast-grep:
# List of rules directories.
# Default: []
rule_dirs: []
# List of utils directories.
# Default: []
util_dirs: []
# Use ast-grep essentials package.
# Default: true
essential_rules: true
# Predefined packages to be used.
# Default: []
packages: []
# ShellCheck is a static analysis tool that finds bugs in your shell scripts.
# Default: {}
shellcheck:
# Enable ShellCheck - ShellCheck is a static analysis tool that finds bugs in your shell. - Enable ShellCheck integration. - v0.10.0
# Default: true
enabled: true
# Ruff is a Python linter and code formatter.
# Default: {}
ruff:
# Enable Ruff - Ruff is a Python linter and code formatter. - Enable Ruff integration. - v0.12.2
# Default: true
enabled: true
# markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files.
# Default: {}
markdownlint:
# Enable markdownlint - markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. - Enable markdownlint integration. - v0.17.2
# Default: true
enabled: true
# GitHub Checks integration configuration.
# Default: {}
github-checks:
# Enable GitHub Checks - Enable integration, defaults to true - Enable GitHub Checks integration.
# Default: true
enabled: true
# Time in milliseconds to wait for all GitHub Checks to conclude. Default 90 seconds, max 15 minutes (900000ms).
# Default: 90000
timeout_ms: 90000
# LanguageTool is a style and grammar checker for 30+ languages.
# Default: {}
languagetool:
# Enable LanguageTool - Enable LanguageTool integration.
# Default: true
enabled: true
# IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.
# Default: []
enabled_rules: []
# IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled.
# Default: []
disabled_rules: []
# IDs of categories to be enabled.
# Default: []
enabled_categories: []
# IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled.
# Default: []
disabled_categories: []
# Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled.
# Default: false
enabled_only: false
# If set to 'picky', additional rules will be activated, i.e. rules that you might only find useful when checking formal text.
# Options: default, picky
# Default: "default"
level: "default"
# Biome is a fast formatter, linter, and analyzer for web projects.
# Default: {}
biome:
# Enable Biome - Biome is a fast formatter, linter, and analyzer for web projects. - Enable Biome integration. - v2.1.2
# Default: true
enabled: true
# Hadolint is a Dockerfile linter.
# Default: {}
hadolint:
# Enable Hadolint - Hadolint is a Dockerfile linter. - Enable Hadolint integration. - v2.12.0
# Default: true
enabled: true
# SwiftLint integration configuration object.
# Default: {}
swiftlint:
# Enable SwiftLint - SwiftLint is a Swift linter. - Enable SwiftLint integration. - v0.57.0
# Default: true
enabled: true
# Optional path to the SwiftLint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.swiftlint.yml' or '.swiftlint.yaml'.
config_file: "example-value"
# PHPStan is a tool to analyze PHP code.
# Default: {}
phpstan:
# Enable PHPStan - PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. - v2.1.17
# Default: true
enabled: true
# Level - Specify the [rule level](https://phpstan.org/user-guide/rule-levels) to run. This setting is ignored if your configuration file already has a `level:` parameter.
# Options: default, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, max
# Default: "default"
level: "default"
# PHPMD is a tool to find potential problems in PHP code.
# Default: {}
phpmd:
# Enable PHPMD - PHPMD is a tool to find potential problems in PHP code. - v2.15.0
# Default: true
enabled: true
# PHP CodeSniffer is a PHP linter and coding standard checker.
# Default: {}
phpcs:
# Enable PHP CodeSniffer - PHP CodeSniffer is a PHP linter and coding standard checker. - v3.7.2
# Default: true
enabled: true
# golangci-lint is a fast linters runner for Go.
# Default: {}
golangci-lint:
# Enable golangci-lint - golangci-lint is a fast linters runner for Go. - Enable golangci-lint integration. - v2.2.2
# Default: true
enabled: true
# Optional path to the golangci-lint configuration file relative to the repository. Useful when the configuration file is named differently than the default '.golangci.yml', '.golangci.yaml', '.golangci.toml', '.golangci.json'.
config_file: "example-value"
# YAMLlint is a linter for YAML files.
# Default: {}
yamllint:
# Enable YAMLlint - YAMLlint is a linter for YAML files. - Enable YAMLlint integration. - v1.37.1
# Default: true
enabled: true
# Gitleaks is a secret scanner.
# Default: {}
gitleaks:
# Enable Gitleaks - Gitleaks is a secret scanner. - Enable Gitleaks integration. - v8.27.2
# Default: true
enabled: true
# Checkov is a static code analysis tool for infrastructure-as-code files.
# Default: {}
checkov:
# Enable Checkov - Checkov is a static code analysis tool for infrastructure-as-code files. - v3.2.334
# Default: true
enabled: true
# Detekt is a static code analysis tool for Kotlin files.
# Default: {}
detekt:
# Enable detekt - detekt is a static code analysis tool for Kotlin files. - v1.23.8
# Default: true
enabled: true
# Optional path to the detekt configuration file relative to the repository.
config_file: "example-value"
# ESLint is a static code analysis tool for JavaScript files.
# Default: {}
eslint:
# Enable ESLint - ESLint is a static code analysis tool for JavaScript files.
# Default: true
enabled: true
# Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script.
# Default: {}
flake8:
# Enable Flake8 - Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script. - v7.2.0
# Default: true
enabled: true
# RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter.
# Default: {}
rubocop:
# Enable RuboCop - RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. - v1.76.1
# Default: true
enabled: true
# Buf offers linting for Protobuf files.
# Default: {}
buf:
# Enable Buf - Buf offers linting for Protobuf files. - v1.55.1
# Default: true
enabled: true
# Regal is a linter and language server for Rego.
# Default: {}
regal:
# Enable Regal - Regal is a linter and language server for Rego. - v0.35.1
# Default: true
enabled: true
# actionlint is a static checker for GitHub Actions workflow files.
# Default: {}
actionlint:
# Enable actionlint - is a static checker for GitHub Actions workflow files. - v1.7.7
# Default: true
enabled: true
# PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java.
# Default: {}
pmd:
# Enable PMD - PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. - v7.15.0
# Default: true
enabled: true
# Optional path to the PMD configuration file relative to the repository.
config_file: "example-value"
# Cppcheck is a static code analysis tool for the C and C++ programming languages.
# Default: {}
cppcheck:
# Enable Cppcheck - Cppcheck is a static code analysis tool for the C and C++ programming languages. - v2.17.1
# Default: true
enabled: true
# Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues.
# Default: {}
semgrep:
# Enable Semgrep - Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. - Enable Semgrep integration. - v1.128.1
# Default: true
enabled: true
# Optional path to the Semgrep configuration file relative to the repository.
config_file: "example-value"
# CircleCI tool is a static checker for CircleCI config files.
# Default: {}
circleci:
# Enable CircleCI - CircleCI tool is a static checker for CircleCI config files. - v0.1.32638
# Default: true
enabled: true
# Clippy is a collection of lints to catch common mistakes and improve your Rust code.
# Default: {}
clippy:
# Enable Clippy - Clippy is a collection of lints to catch common mistakes and improve your Rust code. - Enable Clippy integration.
# Default: true
enabled: true
# SQLFluff is an open source, dialect-flexible and configurable SQL linter.
# Default: {}
sqlfluff:
# Enable SQLFluff - SQLFluff is an open source, dialect-flexible and configurable SQL linter. - v3.4.1
# Default: true
enabled: true
# Configuration for Prisma Schema linting to ensure schema file quality
# Default: {}
prismaLint:
# Enable Prisma Schema linting - Prisma Schema linting helps maintain consistent and error-free schema files - v0.10.2
# Default: true
enabled: true
# Pylint is a Python static code analysis tool.
# Default: {}
pylint:
# Enable Pylint - Pylint is a Python static code analysis tool. - v3.3.7
# Default: true
enabled: true
# Oxlint is a JavaScript/TypeScript linter for OXC written in Rust.
# Default: {}
oxc:
# Enable Oxlint - Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. - v0.16.10
# Default: true
enabled: true
# Configuration for Shopify Theme Check to ensure theme quality and best practices
# Default: {}
shopifyThemeCheck:
# Enable Shopify Theme Check - A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices - cli 3.77.1 - theme 3.58.2
# Default: true
enabled: true
# Configuration for Lua code linting to ensure code quality
# Default: {}
luacheck:
# Enable Lua code linting - Luacheck helps maintain consistent and error-free Lua code - v1.2.0
# Default: true
enabled: true
# Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. - v7.0.2
# Default: {}
brakeman:
# Enable Brakeman - Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. - v7.0.2
# Default: true
enabled: true
# dotenv-linter is a tool for checking and fixing .env files for problems and best practices
# Default: {}
dotenvLint:
# Enable dotenv-linter - dotenv-linter is a tool for checking and fixing .env files for problems and best practices - v3.3.0
# Default: true
enabled: true
# HTMLHint is a static code analysis tool for HTML files.
# Default: {}
htmlhint:
# Enable HTMLHint - HTMLHint is a static code analysis tool for HTML files. - Enable HTMLHint integration. - v1.5.0
# Default: true
enabled: true
# checkmake is a linter for Makefiles.
# Default: {}
checkmake:
# Enable checkmake - checkmake is a linter for Makefiles. - v0.2.2
# Default: true
enabled: true
# OSV Scanner is a tool for vulnerability package scanning.
# Default: {}
osvScanner:
# Enable OSV Scanner - OSV Scanner is a tool for vulnerability package scanning - v2.1.0
# Default: true
enabled: true
# =============================================================================
# CHAT
# Configuration for chat
# =============================================================================
# Configuration for chat
# Default: {}
chat:
# Generate art in response to chat messages. CodeRabbit expresses emotions as either ASCII or Emoji art.
# Default: true
art: true
# Enable the bot to reply automatically without requiring the user to tag it.
# Default: true
auto_reply: true
# Configuration for integrations
# Default: {}
integrations:
# Configuration for jira
# Default: {}
jira:
# Jira - Enable the Jira integration for opening issues, etc. 'auto' disables the integration for public repositories.
# Options: auto, enabled, disabled
# Default: "auto"
usage: "auto"
# Configuration for linear
# Default: {}
linear:
# Linear - Enable the Linear integration for opening issues, etc. 'auto' disables the integration for public repositories.
# Options: auto, enabled, disabled
# Default: "auto"
usage: "auto"
# =============================================================================
# KNOWLEDGE BASE
# Configuration for knowledge base
# =============================================================================
# Configuration for knowledge base
# Default: {}
knowledge_base:
# Opt Out - Disable all knowledge base features that require data retention. If you opt out after opting in, all of your existing knowledge base data will be removed from the system.
# Default: false
opt_out: false
# Configuration for web search
# Default: {}
web_search:
# Web Search - Enable the web search integration.
# Default: true
enabled: true
# CodeRabbit will analyse and learn from your organization's code guidelines, which you can mention in the file patterns section. These guidelines will then be used to conduct thorough code reviews.
# Default: {}
code_guidelines:
# Enabled - Enable CodeRabbit to enforce your organization's coding standards during reviews.
# Default: true
enabled: true
# File Patterns - Specify files for your coding guideline documents in this section. CodeRabbit will scan these files to understand your team's standards and apply them during code reviews. Multiple files supported. File names are case-sensitive. Common files like: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/*.instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/*, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md, **/AGENTS.md) are included by default.
# Default: []
filePatterns: []
# Configuration for learnings
# Default: {}
learnings:
# Learnings - Specify the scope of learnings to use for the knowledge base. 'local' uses the repository's learnings, 'global' uses the organization's learnings, and 'auto' uses repository's learnings for public repositories and organization's learnings for private repositories.
# Options: local, global, auto
# Default: "auto"
scope: "auto"
# Configuration for issues
# Default: {}
issues:
# Issues - Specify the scope of git platform (GitHub/GitLab) issues to use for the knowledge base. 'local' uses the repository's issues, 'global' uses the organization's issues, and 'auto' uses repository's issues for public repositories and organization's issues for private repositories.
# Options: local, global, auto
# Default: "auto"
scope: "auto"
# Configuration for jira
# Default: {}
jira:
# Jira - Enable the Jira knowledge base integration. 'auto' disables the integration for public repositories.
# Options: auto, enabled, disabled
# Default: "auto"
usage: "auto"
# Jira Project Keys - Specify the Jira project keys to use for the knowledge base.
# Default: []
project_keys: []
# Configuration for linear
# Default: {}
linear:
# Linear - Enable the Linear knowledge base integration. 'auto' disables the integration for public repositories.
# Options: auto, enabled, disabled
# Default: "auto"
usage: "auto"
# Linear Team Keys - Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. 'ENG'
# Default: []
team_keys: []
# Configuration for pull requests
# Default: {}
pull_requests:
# Pull Requests - Specify the scope of pull requests to use for the knowledge base. 'local' uses the repository's pull requests, 'global' uses the organization's pull requests, and 'auto' uses repository's pull requests for public repositories and organization's pull requests for private repositories.
# Options: local, global, auto
# Default: "auto"
scope: "auto"
# Configuration for mcp
# Default: {}
mcp:
# MCP - Enable the MCP knowledge base integration. 'auto' disables the integration for public repositories.
# Options: auto, enabled, disabled
# Default: "auto"
usage: "auto"
# MCP Disabled Servers - Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries.
# Default: []
disabled_servers: []
# =============================================================================
# CODE GENERATION
# Configuration for code generation
# =============================================================================
# Configuration for code generation
# Default: {}
code_generation:
# Settings related to the generation of docstrings.
# Default: {"path_instructions":[]}
docstrings:
# Set the language for docstrings by using the corresponding ISO language code.
# Options: de, de-DE, de-AT, de-CH, en, en-US, en-AU, en-GB, en-CA, en-NZ, en-ZA, es, es-AR, fr, fr-CA, fr-CH, fr-BE, nl, nl-BE, pt-AO, pt, pt-BR, pt-MZ, pt-PT, ar, ast-ES, ast, be-BY, be, br-FR, br, ca-ES, ca, ca-ES-valencia, ca-ES-balear, da-DK, da, de-DE-x-simple-language, el-GR, el, eo, fa, ga-IE, ga, gl-ES, gl, it, ja-JP, ja, km-KH, km, ko-KR, ko, pl-PL, pl, ro-RO, ro, ru-RU, ru, sk-SK, sk, sl-SI, sl, sv, ta-IN, ta, tl-PH, tl, tr, uk-UA, uk, zh-CN, zh, crh-UA, crh, cs-CZ, cs, nb, no, nl-NL, de-DE-x-simple-language-DE, es-ES, it-IT, fa-IR, sv-SE, de-LU, fr-FR, bg-BG, bg, he-IL, he, hi-IN, hi, vi-VN, vi, th-TH, th, bn-BD, bn
# Default: "en-US"
language: "en-US"
# Path Instructions - Provide additional guidelines for docstring generation based on file paths.
# Default: []
path_instructions: []
# Settings related to the generation of unit tests.
# Default: {"path_instructions":[]}
unit_tests:
# Unit Test Generation - Provide additional guidelines for unit test generation based on file paths.
# Default: []
path_instructions: []