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.
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
USWDS - Bug: Update capitalization of npm In README #5876
Comments
Looks like there is only one instance that might need changing, where it appears at the beginning of the sentence. Any ideas on how we should rewrite that sentence so |
@mahoneycm - How about "Use the npm package manager for Node-based projects."? |
@sarah-sch - I noticed that there's another use of
Taking a crack at rewriting both sentences:
Feel free to modify as you see fit! Also, I found a sentence on the npm website where they actually start a sentence with
For our site, its probably still better to continue avoiding using it at the beginning of any sentences but wanted to share! |
@mahoneycm - does this re-write work? Alternatively (because I'm not sure who should be doing the action in the second sentence): Or just Even if npm doesn't capitalize their name at the beginning of a sentence on their site, it's ok for us to follow our own style guide and capitalize when we start a sentence with "Npm." |
@sarah-sch My initial hangup was with "npm package manager" because I hadn't seen it referred to it that way. It was always "the package manager, npm" or "npm is a package manager". I think because it reads like saying "ATM machine" since it gets it's name from "node package manager". That said, I looked around and found that Node.js has said the same thing on their site:
|
This issue is for the README which also updates the site Documentation page. Where possible, avoid beginning sentences with words like "npm" that conventionally begin with a lowercase letter. When it appears at the beginning of a sentence, capitalize the N in npm.
See this conversation in Slack for more context on the decision about why to capitalize the N in npm at the beginning of a sentence.
The text was updated successfully, but these errors were encountered: