Skip to content

Commit cdf988d

Browse files
authored
Merge pull request #967 from ethereum-optimism/coderabbit-info
Update coderabbit instructions
2 parents 5b7c0da + 8c13e6e commit cdf988d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

.coderabbit.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ reviews:
1111
"ALWAYS review Markdown content THOROUGHLY with the following criteria:
1212
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
1313
- Avoid gender-specific language and use the imperative form.
14-
- Monitor capitalization for emphasis. Use **bold** for prominence instead of all caps or italics.
14+
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
1515
- Ensure proper nouns are capitalized in sentences.
1616
- Apply the Oxford comma.
1717
- 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.
1818
- Use correct spelling and grammar at all times (IMPORTANT).
19+
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
20+
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
1921
"
2022
auto_review:
2123
enabled: true

0 commit comments

Comments
 (0)