Skip to content

Commit 14b0cde

Browse files
authored
chore: add coderabbit config (#40)
1 parent 56be616 commit 14b0cde

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

.coderabbit.yaml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# https://docs.coderabbit.ai/guides/configure-coderabbit
2+
language: "en-US"
3+
early_access: false
4+
chat: { auto_reply: true }
5+
tone_instructions: >-
6+
Maintain a formal tone, highlighting issues, and suggesting production-grade, elegant, and concise solutions.
7+
8+
reviews:
9+
profile: chill
10+
high_level_summary: true
11+
12+
poem: false
13+
14+
collapse_walkthrough: true
15+
sequence_diagrams: true
16+
17+
path_filters:
18+
- "**/*"
19+
- "!**/out/**"
20+
- "!**/cache/**"
21+
- "!**/artifacts/**"
22+
- "!**/node_modules/**"
23+
- "!**/lib/**"
24+
- "!**/broadcast/**"
25+
- "!**/*.json"
26+
- "!**/coverage/**"
27+
- "!**/lcov.info"
28+
29+
path_instructions:
30+
- path: '**/*.sol'
31+
instructions: >-
32+
Review the Solidity smart contract code, focusing on security vulnerabilities,
33+
gas optimization, best practices, and potential reentrancy issues. Check for
34+
proper access controls, input validation, and adherence to established patterns
35+
like CEI (Checks-Effects-Interactions).
36+
- path: '**/test/**/*.sol'
37+
instructions: >-
38+
Review the Solidity test files, ensuring comprehensive test coverage,
39+
proper edge case handling, and correct use of Foundry testing patterns.
40+
Check for proper setup, teardown, and assertion patterns.
41+
- path: '**/script/**/*.sol'
42+
instructions: >-
43+
Review the Foundry deployment and interaction scripts, focusing on
44+
proper error handling, security considerations, and deployment safety.
45+
Ensure scripts are idempotent and handle network-specific configurations.
46+
- path: '**/*.sh'
47+
instructions: >-
48+
Review the shell scripts, point out issues relative to security,
49+
performance, and maintainability.
50+
- path: '**/foundry.toml'
51+
instructions: >-
52+
Review the Foundry configuration, checking for appropriate compiler
53+
settings, optimization levels, and project structure configuration.
54+
55+
auto_review:
56+
drafts: false
57+
# disables review for new commits
58+
auto_incremental_review: false
59+
base_branches:
60+
- main
61+
62+
tools:
63+
languagetool:
64+
enabled: true
65+
level: default

0 commit comments

Comments
 (0)