Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated coderabbit rules #974

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Updated coderabbit rules #974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c522cb4
Updated coderabbit rules
krofax Oct 9, 2024
f68d1bd
update the rules and added a list
krofax Oct 9, 2024
5699d6f
Update nouns.txt
krofax Oct 11, 2024
15c6cd3
Update nouns.txt
krofax Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .coderabbit.yaml
View file
Open in desktop
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm slightly confused here. So this is saying that CodeRAbbit should look at nouns.txt as a whitelist of sorts for words that are allowed to be capitalized in headers correct?

If so, I think we need to take another pass at the list. I think it should exclusively be proper nouns and not just web3 terms

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, so this list is by no means a standard, we can always update it, what we have there are placeholders.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree with both sentiments here,

  • seems like we get the rule and the nouns.txt file in place and we can add to it as we go along (just like we did/have been doing with the words.txt file).
  • but also wonder if we could have coderabbit do an initial sweep thru the docs to populate the current list more?

- 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
12 changes: 12 additions & 0 deletions nouns.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Optimism
OP Mainnet
Ethereum
JavaScript
NFT
Web3
DeFi
DAO
EVM
L2
dApp
Copy link
Collaborator

@cpengilly cpengilly Oct 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krofax we no longer use dApp here at OP Labs, a decision from product team (before you two joined). all instances were removed from docs a few months ago and replaced with just app

seems like we could add to this list: OP Stack, OP Chains, Superchain, Collective, Foundation, Security Council, Alt-DA, Mission Grants, Supersim, SuperchainERC20, CLI, Faucet, Dev Console, Paymaster, Tokenlist

MetaMask
Loading