-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.coderabbit.yaml
More file actions
40 lines (40 loc) · 1.41 KB
/
.coderabbit.yaml
File metadata and controls
40 lines (40 loc) · 1.41 KB
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
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
early_access: false
# enable_free_tier: true
tone_instructions: |
Provide clear, concise, and professional feedback focused on improving documentation clarity, grammar, and consistency.
Suggest improvements for readability and structure, and highlight any potential ambiguities.
reviews:
profile: "assertive"
request_changes_workflow: false
high_level_summary: true
poem: false
review_status: true
collapse_walkthrough: false
sequence_diagrams: false
auto_review:
enabled: false
drafts: false
path_instructions:
- path: "**/*.rst"
instructions: |
Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use `list-table`.
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.
- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
path_filters:
- "!**/*.png"
finishing_touches:
unit_tests:
enabled: false
docstrings:
enabled: false
chat:
auto_reply: false