-
Notifications
You must be signed in to change notification settings - Fork 1
/
.coderabbit.yaml
47 lines (47 loc) · 2.45 KB
/
.coderabbit.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
language: "en"
early_access: true
tone_instructions: |
Be casual, friendly, and egoless, using approachable, clear, and conversational language that feels warm and engaging.
Keep the writing light, concise, and positive, as if speaking to a peer.
reviews:
request_changes_workflow: true
high_level_summary: true
poem: false
review_status: true
collapse_walkthrough: false
sequence_diagrams: true
path_filters:
- "!**/*.pb.go"
path_instructions:
- path: "**/*.go"
instructions: |
Review the Golang files with a focus on the project's goals:
- Actor Model Integration: Ensure the code effectively utilizes the [protoactor](https://github.com/AsynkronIT/protoactor-go)
framework, adhering to best practices of the Actor Model.
- Domain-Driven Design: Verify that Domain-Driven Design principles are integrated properly, with clear separation of concerns
and well-defined domain models. Ensure the use of Event Sourcing is correctly implemented in the Actor-based system.
- Code Quality and Maintainability: Focus on readability, proper use of Go idioms, and maintainable code structure. Check
for consistent naming conventions, efficient error handling, and adequate documentation, including meaningful comments where needed.
- Performance and Scalability: Identify any potential areas for performance improvement, especially concerning actor behavior,
concurrency, and data persistence. Suggest refactoring if the code can be streamlined or optimized.
- path: "**/*.md"
instructions: |
Review markdown documentation with these guidelines:
- Structure: Ensure consistent heading hierarchy and document organization
- Content: Verify accuracy of technical details, code examples, and API references
- Quality: Check for spelling, grammar, and broken links
- Completeness: Confirm all features and changes are properly documented
- Style: Follow project's documentation style guide and formatting conventions
auto_review:
enabled: true
drafts: false
base_branches:
- "main"
chat:
auto_reply: true
auto_reply_messages:
greeting: "👋 Thanks for the mention! 😊 I'm here to assist with your code review."
help_request: "🫡 I'm on it! What specific aspect would you like me to focus on?"
triggers:
- keywords: ["help", "review", "check"]
response: "👌 Got it! I'll review that for you right away."