diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 1d846c65..4bb0d0a9 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -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 diff --git a/nouns.txt b/nouns.txt new file mode 100644 index 00000000..49bee151 --- /dev/null +++ b/nouns.txt @@ -0,0 +1,5 @@ +Optimism +OP Mainnet +Ethereum +OP Stack +MetaMask \ No newline at end of file