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.
This commit is contained in:
Martin Braquet
2026-04-02 18:53:00 +02:00
committed by GitHub
parent 2400d50247
commit 5ea095662b

35
.coderabbit.yaml Normal file
View File

@@ -0,0 +1,35 @@
# Automatically generated PR summaries
description:
# Do you want CodeRabbit to actually edit the PR description body? (Highly recommended)
collapse_walkthrough: false
instructions: |
Summarize the changes clearly.
Format the summary with bullet points.
Highlight any potential breaking changes for users.
# How aggressive and deep the reviews should be
reviews:
# 'chill' (fewer comments, only critical bugs) or 'assertive' (strict, points out everything)
profile: assertive
# Should CodeRabbit formally "Request Changes" (which can block merging) or just leave comments?
# For open-source, 'false' is usually better so it doesn't block community contributors aggressively.
request_changes_workflow: false
# High-level rules for the AI to follow during review
instructions: |
- We use early returns to avoid deep nesting.
- Ensure all public functions have docstrings.
- Flag any hardcoded strings; they should be in the constants file.
- Check for edge cases like null values or empty arrays.
- Suggest performance optimizations where appropriate.
# What files should the AI ignore? (Crucial to save time and avoid noise)
path_filters:
# Files to ALWAYS ignore
exclude:
- "**/*.md" # Ignore markdown docs
- "package-lock.json" # Ignore lock files
- "yarn.lock"
- "dist/**" # Ignore compiled output
- "test/mocks/**" # Ignore mock data