Skip to content

Add Code Rabbit AI config #156

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.

Sign up for GitHub

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
mvandeberg merged 1 commit into from
Jan 22, 2026
Merged

Add Code Rabbit AI config #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 58 additions & 0 deletions .coderabbit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# https://docs.coderabbit.ai/reference/configuration

language: en

early_access: false

chat:
auto_reply: true

reviews:
auto_review:
enabled: true
ignore_title_keywords:
- "WIP"
drafts: false
base_branches:
- master
- develop

high_level_summary: true

# Generate sequence diagrams for complex code flows
sequence_diagrams: true

poem: true
review_status: true
collapse_walkthrough: true
changed_files_summary: true
request_changes_workflow: false

pre_merge_checks:
description:
mode: warning # Options: off, warning, error
docstrings:
mode: off # Disabled: cannot exclude detail namespaces from coverage

path_filters:
- "!**/bench/**"
- "!**/build/**"
- "!**/context/**"
- "!**/doc/**"
- "!**/meta/**"
- "!**/papers/**"
- "!**/test/**"

# Custom review instructions for specific file patterns
path_instructions:
- path: "**/*.{cpp,hpp}"
instructions: |
Documentation Best Practices
- The top of the file after the includes, put a nice /* */ section
which gives a high level overview of how the implementation works.
- Single line // comments are to be used sparingly and judiciously
which explain the why (not the what or how) when it is non-obvious.
- Docstrings are required for all classes in public headers in
non detail namespaces. They are used for generating the Documentation
website. Please give warnings for any class or function that does
not have a docstring or has an insufficient docstring.
Comment on lines +48 to +58
Copy link

@coderabbitai coderabbitai bot Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Minor grammatical improvement in instructions.

Line 51 has awkward phrasing that could be clarified for better readability.

Suggested fix 
  path_instructions:
    - path: "**/*.{cpp,hpp}"
      instructions: |
        Documentation Best Practices
-        - The top of the file after the includes, put a nice /* */ section
+        - At the top of the file after the includes, put a nice /* */ section
          which gives a high level overview of how the implementation works.
        - Single line // comments are to be used sparingly and judiciously
          which explain the why (not the what or how) when it is non-obvious.
        - Docstrings are required for all classes in public headers in
          non detail namespaces. They are used for generating the Documentation
          website. Please give warnings for any class or function that does
          not have a docstring or has an insufficient docstring.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- path: "**/*.{cpp,hpp}"
instructions: |
Documentation Best Practices
- The top of the file after the includes, put a nice /* */ section
which gives a high level overview of how the implementation works.
- Single line // comments are to be used sparingly and judiciously
which explain the why (not the what or how) when it is non-obvious.
- Docstrings are required for all classes in public headers in
non detail namespaces. They are used for generating the Documentation
website. Please give warnings for any class or function that does
not have a docstring or has an insufficient docstring.
- path: "**/*.{cpp,hpp}"
instructions: |
Documentation Best Practices
- At the top of the file after the includes, put a nice /* */ section
which gives a high level overview of how the implementation works.
- Single line // comments are to be used sparingly and judiciously
which explain the why (not the what or how) when it is non-obvious.
- Docstrings are required for all classes in public headers in
non detail namespaces. They are used for generating the Documentation
website. Please give warnings for any class or function that does
not have a docstring or has an insufficient docstring.
🤖 Prompt for AI Agents 
In @.coderabbit.yaml around lines 48 - 58, Reword the documentation guidance
under the "**/*.{cpp,hpp}" instructions to improve clarity: change "which gives
a high level overview of how the implementation works." to "Provide a high-level
overview of the implementation."; tighten the next sentence to "Use single-line
// comments sparingly to explain the why (not the what or how) when it is
non-obvious." and clarify the final sentence to "Docstrings are required for all
classes in public headers within non-detail namespaces; warn when a class or
function lacks a docstring or has an insufficient one." Ensure these phrases
replace the current lines in the instructions block so the intent and grammar
are clearer.

Loading