Skip to content

Commit

Permalink
Merge pull request #974 from ethereum-optimism/update-coderabbit-rule
Browse files Browse the repository at this point in the history
Updated coderabbit rules
  • Loading branch information
krofax authored Oct 29, 2024
2 parents 2301ecb + d703984 commit 62120b4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
10 changes: 7 additions & 3 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ reviews:
- 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 proper title case for 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.
- For H1, H2, and H3 headers:
1. Use sentence case, capitalizing only the first word.
2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
auto_review:
enabled: true
Expand Down
5 changes: 5 additions & 0 deletions nouns.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Optimism
OP Mainnet
Ethereum
OP Stack
MetaMask

0 comments on commit 62120b4

Please sign in to comment.