Skip to content

Commit 5ea0956

Browse files
Add CodeRabbit configuration for PR reviews
This configuration file sets up CodeRabbit's behavior for PR summaries and reviews, including instructions for summarizing changes, review profiles, and file exclusions.
1 parent 2400d50 commit 5ea0956

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

.coderabbit.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Automatically generated PR summaries
2+
description:
3+
# Do you want CodeRabbit to actually edit the PR description body? (Highly recommended)
4+
collapse_walkthrough: false
5+
instructions: |
6+
Summarize the changes clearly.
7+
Format the summary with bullet points.
8+
Highlight any potential breaking changes for users.
9+
10+
# How aggressive and deep the reviews should be
11+
reviews:
12+
# 'chill' (fewer comments, only critical bugs) or 'assertive' (strict, points out everything)
13+
profile: assertive
14+
15+
# Should CodeRabbit formally "Request Changes" (which can block merging) or just leave comments?
16+
# For open-source, 'false' is usually better so it doesn't block community contributors aggressively.
17+
request_changes_workflow: false
18+
19+
# High-level rules for the AI to follow during review
20+
instructions: |
21+
- We use early returns to avoid deep nesting.
22+
- Ensure all public functions have docstrings.
23+
- Flag any hardcoded strings; they should be in the constants file.
24+
- Check for edge cases like null values or empty arrays.
25+
- Suggest performance optimizations where appropriate.
26+
27+
# What files should the AI ignore? (Crucial to save time and avoid noise)
28+
path_filters:
29+
# Files to ALWAYS ignore
30+
exclude:
31+
- "**/*.md" # Ignore markdown docs
32+
- "package-lock.json" # Ignore lock files
33+
- "yarn.lock"
34+
- "dist/**" # Ignore compiled output
35+
- "test/mocks/**" # Ignore mock data

0 commit comments

Comments
 (0)