From c522cb4aff6238005b065dcf451ca63845630c7a Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Wed, 9 Oct 2024 14:41:46 +0100 Subject: [PATCH 1/5] Updated coderabbit rules --- .coderabbit.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 1d846c659..f5659debb 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. Examples include 'Optimism', 'OP Mainnet', 'Ethereum', 'JavaScript', 'NFT', etc. + 3. Do not automatically lowercase words that might be proper nouns or technical terms. + - Flag any headers that seem to inconsistently apply these rules for manual review. + - Refer to a predefined list of proper nouns and technical terms specific to the project, which should be kept capitalized regardless of their position in the header. " auto_review: enabled: true From f68d1bd6012a5205999247c2f013bd27b2c81c12 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Wed, 9 Oct 2024 14:54:42 +0100 Subject: [PATCH 2/5] update the rules and added a list --- .coderabbit.yaml | 6 +++--- nouns.txt | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 nouns.txt diff --git a/.coderabbit.yaml b/.coderabbit.yaml index f5659debb..4bb0d0a94 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -18,10 +18,10 @@ reviews: - Use correct spelling and grammar at all times (IMPORTANT). - 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. Examples include 'Optimism', 'OP Mainnet', 'Ethereum', 'JavaScript', 'NFT', etc. - 3. Do not automatically lowercase words that might be proper nouns or technical terms. + 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. - - Refer to a predefined list of proper nouns and technical terms specific to the project, which should be kept capitalized regardless of their position in the header. + - 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 000000000..17280947d --- /dev/null +++ b/nouns.txt @@ -0,0 +1,20 @@ +Optimism +OP Mainnet +Ethereum +JavaScript +NFT +Web3 +DeFi +DAO +EVM +Layer 2 +L2 +Rollup +Smart Contract +Blockchain +Cryptocurrency +Token +Wallet +dApp +Gas Fee +MetaMask \ No newline at end of file From 5699d6f59b07e87fd432b36263ed804407ae65f7 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Fri, 11 Oct 2024 12:37:53 +0100 Subject: [PATCH 3/5] Update nouns.txt Co-authored-by: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> --- nouns.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/nouns.txt b/nouns.txt index 17280947d..8352a8271 100644 --- a/nouns.txt +++ b/nouns.txt @@ -7,7 +7,6 @@ Web3 DeFi DAO EVM -Layer 2 L2 Rollup Smart Contract From 15c6cd3c36a32524dae6fa8dfa1b9d4dd3662845 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Fri, 11 Oct 2024 12:45:07 +0100 Subject: [PATCH 4/5] Update nouns.txt Co-authored-by: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> --- nouns.txt | 7 ------- 1 file changed, 7 deletions(-) diff --git a/nouns.txt b/nouns.txt index 8352a8271..22467f4ab 100644 --- a/nouns.txt +++ b/nouns.txt @@ -8,12 +8,5 @@ DeFi DAO EVM L2 -Rollup -Smart Contract -Blockchain -Cryptocurrency -Token -Wallet dApp -Gas Fee MetaMask \ No newline at end of file From d703984b8a7640acc2ffc90d9d0df963aecc8dbb Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Tue, 29 Oct 2024 16:27:19 +0100 Subject: [PATCH 5/5] Update nouns.txt Co-authored-by: soyboy <85043086+sbvegan@users.noreply.github.com> --- nouns.txt | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/nouns.txt b/nouns.txt index 22467f4ab..49bee1513 100644 --- a/nouns.txt +++ b/nouns.txt @@ -1,12 +1,5 @@ Optimism OP Mainnet Ethereum -JavaScript -NFT -Web3 -DeFi -DAO -EVM -L2 -dApp +OP Stack MetaMask \ No newline at end of file