Skip to content

Commit

Permalink
Merge pull request #967 from ethereum-optimism/coderabbit-info
Browse files Browse the repository at this point in the history
Update coderabbit instructions
  • Loading branch information
krofax authored Oct 8, 2024
2 parents 5b7c0da + 8c13e6e commit cdf988d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ reviews:
"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. Use **bold** for prominence instead of all caps or italics.
- 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
Expand Down

0 comments on commit cdf988d

Please sign in to comment.