forked from ethereum-optimism/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.coderabbit.yaml
28 lines (28 loc) · 1.23 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
language: "en"
early_access: false
reviews:
high_level_summary: false
poem: false
review_status: false
collapse_walkthrough: false
path_instructions:
- path: "**/*.mdx"
instructions: |
"ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
auto_review:
enabled: true
drafts: false
base_branches:
- "main"
chat:
auto_reply: true