Skip to content

Commit e96d0e2

Browse files
authored
Add initial configuration for CodeRabbit integration
1 parent b69f2bf commit e96d0e2

1 file changed

Lines changed: 114 additions & 0 deletions

File tree

.coderabbit.yaml

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
language: en-US
3+
tone_instructions: "You are a principal engineer with natural teaching abilities. You detect issues and clearly explain why. Read the docs and CLAUDE.md files."
4+
reviews:
5+
profile: assertive
6+
high_level_summary: true
7+
#paths to ignore, customize for your stack
8+
path_filters:
9+
- "!node_modules/**"
10+
- "!dist/**"
11+
- "!target/**"
12+
- "!.git/**"
13+
- "program-libs/**"
14+
- "programs/**"
15+
- "sdk-libs/**"
16+
- "prover/**"
17+
- "forester/**"
18+
- "docs/**"
19+
- "*.md"
20+
- "!LICENSE"
21+
22+
path_instructions:
23+
- path: "**/docs/**/*.md"
24+
instructions: |
25+
When reviewing batched Merkle tree documentation changes:
26+
1. **Critical**: Verify that all function signatures, struct definitions, and behavior described in the documentation accurately match the actual implementation in `**/src/`
27+
2. Cross-reference any mentioned function names, parameters, return types, and error conditions with the source code
28+
3. Check that code examples and usage patterns reflect the current API in the crate
29+
4. Validate that any referenced constants, enums, or type definitions exist and have correct values
30+
5. Ensure documentation describes the actual behavior, not outdated or planned behavior
31+
6. Flag any references to deprecated functions, renamed structs, or changed interfaces
32+
7. Verify that error handling and edge cases mentioned in docs match the implementation
33+
8. Check that performance characteristics and complexity claims are accurate
34+
9. Do you see any inconsistencies between the documentation and the code in either way?
35+
10. Do you see any weird patterns or anything that doesn't make sense in code or docs?
36+
37+
# add linters and other tools, CodeRabbit will run and check these as part of its review process
38+
# Pre-merge quality gates
39+
pre_merge_checks:
40+
docstrings:
41+
mode: warning
42+
threshold: 70
43+
44+
# Finishing touches for code quality
45+
finishing_touches:
46+
docstrings:
47+
enabled: true
48+
unit_tests:
49+
enabled: true
50+
51+
tools:
52+
github-checks:
53+
timeout_ms: 900000
54+
eslint:
55+
enabled: true
56+
ruff:
57+
enabled: true
58+
gitleaks:
59+
enabled: true
60+
clippy:
61+
enabled: true
62+
yamllint:
63+
enabled: true
64+
markdownlint:
65+
enabled: true
66+
shellcheck:
67+
enabled: true
68+
auto_review:
69+
enabled: true
70+
drafts: false
71+
ignore_title_keywords:
72+
- "wip"
73+
- "draft"
74+
- "temp"
75+
- "test"
76+
- "experimental"
77+
ignore_usernames:
78+
- "dependabot[bot]"
79+
- "dependabot"
80+
labels:
81+
- "!skip-review"
82+
- "!no-review"
83+
- "!dependabot"
84+
base_branches:
85+
- "main"
86+
- "release/*"
87+
88+
chat:
89+
auto_reply: true
90+
art: false
91+
92+
# Enhanced knowledge base configuration
93+
knowledge_base:
94+
opt_out: false
95+
web_search:
96+
enabled: true
97+
learnings:
98+
scope: global
99+
issues:
100+
scope: global
101+
# Coding guidelines for Rust and TypeScript projects
102+
code_guidelines:
103+
enabled: true
104+
filePatterns:
105+
- "*/docs/**"
106+
- "*/**/README.md"
107+
- "program-libs/batched-merkle-tree/docs/**"
108+
- "program-libs/account-checks/docs/**"
109+
- "program-libs/compressible/docs/**"
110+
- "*/**/CLAUDE.md"
111+
- "DOCS.md"
112+
113+
# Additional configuration for Light Protocol specific patterns
114+
early_access: true

0 commit comments

Comments
 (0)