11# CodeRabbit AI Configuration for ContextForge Memory
22# https://docs.coderabbit.ai/guides/code-review-best-practices/
33
4- # General settings
5- review :
6- # Review tone - professional but friendly
7- tone : " professional"
8-
9- # Focus on security, performance, and code quality
10- focus :
11- - " security"
12- - " performance"
13- - " code_quality"
14- - " best_practices"
15- - " documentation"
4+ # Top-level tone instructions (max 250 chars)
5+ tone_instructions : " Professional tone focusing on security, performance, code quality, best practices, and documentation"
166
17- # Ignore certain files and directories
18- ignore :
19- paths :
20- - " **/*.pyc"
21- - " **/__pycache__/**"
22- - " **/.pytest_cache/**"
23- - " **/node_modules/**"
24- - " **/.venv/**"
25- - " **/venv/**"
26- - " **/data/**"
27- - " **/logs/**"
28- - " **/*.log"
29- - " **/safety-results.json"
30- - " **/audit-results.json"
31- - " **/.coverage"
32- - " **/coverage.xml"
33- - " **/dist/**"
34- - " **/build/**"
35- - " **/.mypy_cache/**"
7+ # Review configuration
8+ reviews :
9+ # Path filters for excluding files and directories
10+ path_filters :
11+ - " !**/*.pyc"
12+ - " !**/__pycache__/**"
13+ - " !**/.pytest_cache/**"
14+ - " !**/node_modules/**"
15+ - " !**/.venv/**"
16+ - " !**/venv/**"
17+ - " !**/data/**"
18+ - " !**/logs/**"
19+ - " !**/*.log"
20+ - " !**/safety-results.json"
21+ - " !**/audit-results.json"
22+ - " !**/.coverage"
23+ - " !**/coverage.xml"
24+ - " !**/dist/**"
25+ - " !**/build/**"
26+ - " !**/.mypy_cache/**"
3627
37- # Path-specific instructions
38- path_instructions :
39- # API and main application code
40- - paths : [ "src/**/*.py"]
41- instructions : |
42- Focus on:
43- - API design and RESTful principles
44- - Error handling and validation
45- - Security considerations (input validation, authentication)
46- - Performance implications
47- - Type hints and documentation
48- - FastAPI best practices
28+ # Path-specific review instructions
29+ path_instructions :
30+ # API and main application code
31+ - path : " src/**/*.py"
32+ instructions : |
33+ Focus on:
34+ - API design and RESTful principles
35+ - Error handling and validation
36+ - Security considerations (input validation, authentication)
37+ - Performance implications
38+ - Type hints and documentation
39+ - FastAPI best practices
4940
50- # Client libraries
51- - paths : [ "clients/**/*"]
52- instructions : |
53- Focus on:
54- - API client design patterns
55- - Error handling and retry logic
56- - Type safety and interfaces
57- - Documentation and examples
58- - Cross-platform compatibility
41+ # Client libraries
42+ - path : " clients/**/*"
43+ instructions : |
44+ Focus on:
45+ - API client design patterns
46+ - Error handling and retry logic
47+ - Type safety and interfaces
48+ - Documentation and examples
49+ - Cross-platform compatibility
5950
60- # CI/CD and workflows
61- - paths : [ ".github/**/*"]
62- instructions : |
63- Focus on:
64- - Security best practices
65- - Workflow efficiency
66- - Proper permissions and secrets handling
67- - Dependabot configuration
68- - Security scanning setup
51+ # CI/CD and workflows
52+ - path : " .github/**/*"
53+ instructions : |
54+ Focus on:
55+ - Security best practices
56+ - Workflow efficiency
57+ - Proper permissions and secrets handling
58+ - Dependabot configuration
59+ - Security scanning setup
6960
70- # Documentation
71- - paths : [ "*.md", "docs/**/*"]
72- instructions : |
73- Focus on:
74- - Clarity and completeness
75- - Up-to-date information
76- - Proper markdown formatting
77- - Security policy accuracy
78- - Contribution guidelines
61+ # Documentation
62+ - path : " *.md"
63+ instructions : |
64+ Focus on:
65+ - Clarity and completeness
66+ - Up-to-date information
67+ - Proper markdown formatting
68+ - Security policy accuracy
69+ - Contribution guidelines
7970
80- # Configuration files
81- - paths : ["requirements.txt", "pyproject.toml", "*.yaml", "*.yml"]
82- instructions : |
83- Focus on:
84- - Dependency security and versions
85- - Configuration best practices
86- - Security implications
87- - Proper formatting and structure
71+ - path : " docs/**/* "
72+ instructions : |
73+ Focus on:
74+ - Clarity and completeness
75+ - Up-to-date information
76+ - Proper markdown formatting
77+ - Security policy accuracy
78+ - Contribution guidelines
8879
89- # Review behavior
90- behavior :
91- # Auto-approve if no issues found and all checks pass
92- auto_approve :
93- enabled : true
94- conditions :
95- - " no_security_issues"
96- - " no_critical_issues"
97- - " ci_passes"
98- - " small_change"
80+ # Configuration files
81+ - path : " requirements.txt"
82+ instructions : |
83+ Focus on:
84+ - Dependency security and versions
85+ - Configuration best practices
86+ - Security implications
87+ - Proper formatting and structure
9988
100- # Create issues for significant problems
101- create_issues :
102- enabled : true
103- threshold : " medium"
89+ - path : " pyproject.toml"
90+ instructions : |
91+ Focus on:
92+ - Dependency security and versions
93+ - Configuration best practices
94+ - Security implications
95+ - Proper formatting and structure
10496
105- # Security focus
106- security :
107- # Enhanced security scanning
108- enabled : true
109- focus :
110- - " dependency_vulnerabilities"
111- - " secrets_detection"
112- - " injection_attacks"
113- - " authentication_bypass"
114- - " data_exposure"
97+ - path : " *.yaml"
98+ instructions : |
99+ Focus on:
100+ - Configuration best practices
101+ - Security implications
102+ - Proper formatting and structure
115103
116- # Performance monitoring
117- performance :
118- enabled : true
119- focus :
120- - " api_response_times"
121- - " memory_usage"
122- - " database_queries"
123- - " caching_strategies"
124-
125- # Integration settings
126- integrations :
127- # GitHub integration
128- github :
129- # Comment on PRs
130- comment_on_pr : true
131-
132- # Create issues for problems
133- create_issues : true
134-
135- # Suggest changes
136- suggest_changes : true
137-
138- # Custom review prompts
139- custom_prompts :
140- - name : " ContextForge Memory Review"
141- prompt : |
142- You are reviewing code for ContextForge Memory, a lightweight external memory layer.
143-
144- Key considerations:
145- - This is a memory service with store, search, and embed APIs
146- - Security is critical - this handles potentially sensitive data
147- - Performance matters - it should be fast and efficient
148- - The API should be simple and intuitive
149- - Code should be well-documented and maintainable
150-
151- Pay special attention to:
152- - Input validation and sanitization
153- - Error handling and edge cases
154- - API design consistency
155- - Security vulnerabilities
156- - Performance implications
157- - Code clarity and documentation
104+ - path : " *.yml"
105+ instructions : |
106+ Focus on:
107+ - Configuration best practices
108+ - Security implications
109+ - Proper formatting and structure
0 commit comments