|
1 | 1 | # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json |
2 | 2 | # CodeRabbit config docs: https://docs.coderabbit.ai/reference/configuration |
3 | | -# Defaults and examples GitHub repo: coderabbitai/awesome-coderabbit |
4 | 3 |
|
5 | | -# General settings |
6 | | -language: "en-US" # Language for reviews (default: "en-US") |
7 | | -tone_instructions: "" # Custom tone for reviews (default: "") |
8 | | -inheritance: false # top-level instructions (default: false) |
| 4 | +# This CodeRabbit configuration only included overrides from our |
| 5 | +# organization-level configuration in facioquo/coderabbit .coderabbit.yaml |
| 6 | +inheritance: true |
9 | 7 |
|
10 | | -# preview features |
11 | | -early_access: true # Enable early-access features (default: false) |
12 | | - |
13 | | -# ISSUE ENRICHMENT (preview) |
14 | | -issue_enrichment: |
15 | | - auto_enrich: |
16 | | - enabled: false # Enable auto issue enrichment (default: true) |
17 | | - planning: |
18 | | - enabled: true # Enable generating a planning for issues (default: true) |
19 | | - auto_planning: |
20 | | - enabled: true # Enable auto-generated plans based on labels (default: true) |
21 | | - labels: # Triggering labels for auto-planning (default: []) |
22 | | - - rabbit-plan |
23 | | - labeling: |
24 | | - auto_apply_labels: false |
25 | | - labeling_instructions: [] |
26 | | - |
27 | | -# REVIEWS |
| 8 | +# REVIEW CONFIGURATION (overrides) |
28 | 9 | reviews: |
29 | | - profile: "chill" |
30 | | - review_status: true |
31 | | - commit_status: true |
32 | | - fail_commit_status: false |
33 | | - request_changes_workflow: false |
34 | | - enable_prompt_for_ai_agents: true |
35 | | - in_progress_fortune: false |
36 | | - |
37 | | - abort_on_close: true |
38 | | - disable_cache: false |
39 | | - |
40 | | - # High level summary of the changes in the PR/MR description or walkthrough. |
41 | | - high_level_summary: false |
42 | | - high_level_summary_in_walkthrough: false |
43 | | - high_level_summary_placeholder: "@coderabbitai summary" |
44 | | - |
45 | | - # Walkthrough |
46 | | - collapse_walkthrough: true |
47 | | - changed_files_summary: false # Generate a summary of the changed files in the walkthrough. |
48 | | - sequence_diagrams: false # Generate sequence diagrams in the walkthrough. |
49 | | - estimate_code_review_effort: false # Generate review effort in walkthrough. |
50 | | - assess_linked_issues: true # Assess how well the changes address the linked issues in the walkthrough. |
51 | | - related_issues: true # Include possibly related issues in the walkthrough. |
52 | | - related_prs: true # Include possibly related pull requests in the walkthrough. |
53 | | - poem: false # Generate a poem in the walkthrough comment. |
| 10 | + review_status: false |
| 11 | + commit_status: false |
54 | 12 |
|
55 | 13 | # Automatic review scheduling |
56 | 14 | auto_review: |
57 | | - enabled: true |
58 | | - auto_incremental_review: true # Review each push (default: true) |
| 15 | + enabled: false |
| 16 | + auto_incremental_review: false # Review each push (default: true) |
59 | 17 | drafts: false # Review Draft pull requests (default: false) |
60 | 18 | base_branches: |
61 | 19 | - ".*" |
62 | 20 |
|
63 | | - # Automatic labels |
64 | | - # Suggest labels based on the changes in the pull request in the walkthrough. |
65 | | - suggested_labels: false |
66 | | - auto_apply_labels: false |
67 | | - |
68 | | - # Automatic reviewers |
69 | | - # Suggest reviewers based on the changes in the pull request in the walkthrough. |
70 | | - suggested_reviewers: false |
71 | | - auto_assign_reviewers: false |
72 | | - |
73 | | - # Automatic PR titles |
74 | | - auto_title_placeholder: "@coderabbitai" |
75 | | - auto_title_instructions: | |
76 | | - Use conventional commit with short (<65 chars) sentence case Subject. See Copilot instructions. |
77 | | -
|
78 | | - Title strategy: |
79 | | - - Focus on the PRIMARY contribution or most central feature delivered in the PR |
80 | | - - Do NOT base the title on the last commit message |
81 | | - - Do NOT choose the most verbose or largest change |
82 | | - - Identify the core purpose or business value of the PR |
83 | | - - Keep titles concise and meaningful |
84 | | -
|
85 | | - Requirements: |
86 | | - - Use lowercase for type: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, or plan |
87 | | - - Subject must start with an uppercase letter |
88 | | - - Keep total title length ≤ 65 characters |
89 | | - - Use imperative mood (e.g., "Add feature" not "Added feature") |
90 | | -
|
91 | | - Examples: |
92 | | - - `feat: Add WebSocket support` (not "Update connection manager") |
93 | | - - `fix: Resolve authentication timeout` (not "Fix bug in auth service") |
94 | | - - `docs: Improve API examples` (not "Update documentation files") |
95 | | - - `chore: Update dependencies` (when that's the sole purpose) |
96 | | -
|
97 | | - # Code enhancement features |
98 | | - finishing_touches: |
99 | | - docstrings: |
100 | | - enabled: false # Generate docstrings for PRs/MRs (default: true) |
101 | | - unit_tests: |
102 | | - enabled: false # Generate unit tests for PRs/MRs (default: true) |
103 | | - |
104 | | - # Pre-merge validation checks |
105 | | - pre_merge_checks: |
106 | | - docstrings: # Docstring coverage check (default: warning) |
107 | | - mode: off |
108 | | - description: # PR description validation (default: warning) |
109 | | - mode: off |
110 | | - issue_assessment: # Linked issue assessment (default: warning) |
111 | | - mode: off |
112 | | - title: # PR title validation (default: warning) |
113 | | - mode: off |
114 | | - |
115 | 21 | # Files to include/exclude from reviews |
116 | 22 | path_filters: |
117 | 23 | - "**" # Include all (base) |
|
0 commit comments