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.

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

Open
sarah-sch opened this issue Apr 17, 2024 · 5 comments · May be fixed by #5915
Open

USWDS - Bug: Update capitalization of npm In README #5876

sarah-sch opened this issue Apr 17, 2024 · 5 comments · May be fixed by #5915
Assignees
Labels
Affects: Content Relates to content Status: Triage We're triaging this issue and grooming if necessary Type: Bug A problem in the code
Milestone

Comments

@sarah-sch
Copy link

sarah-sch commented Apr 17, 2024

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.

@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Apr 17, 2024
@mahoneycm mahoneycm added this to the uswds 3.8.1 milestone Apr 18, 2024
@mahoneycm mahoneycm transferred this issue from uswds/uswds-site Apr 18, 2024
@mahoneycm mahoneycm changed the title Update capitalization of npm on Documentation page USWDS: Update capitalization of npm In README Apr 18, 2024
@mahoneycm
Copy link
Contributor

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 npm isn't the first word? If not, we can simply capitalize.

@sarah-sch
Copy link
Author

@mahoneycm - How about "Use the npm package manager for Node-based projects."?

@mahoneycm
Copy link
Contributor

@sarah-sch - I noticed that there's another use of npm at the beginning of the sentence in the same paragraph!

...and compiled files. npm packages make it easy to update and install the design system from the command line.

Taking a crack at rewriting both sentences:

The package manager npm can be used for Node-based projects. USWDS maintains the @uswds/uswds package that includes both the pre-compiled and compiled files. With npm packages, updating and installing the design system from the command line is easy.

Feel free to modify as you see fit!

Also, I found a sentence on the npm website where they actually start a sentence with npm without capitalizing.

About npm
npm is the world's largest software registry. Open source developers from every continent use npm to share and borrow packages, and many organizations use npm to manage private development as well.

For our site, its probably still better to continue avoiding using it at the beginning of any sentences but wanted to share!

@sarah-sch
Copy link
Author

@mahoneycm - does this re-write work?
Use the npm package manager for Node-based projects. USWDS maintains the @uswds/uswds package that includes both the pre-compiled and compiled files. We rely on npm packages to easily update and install the design system from the command line.

Alternatively (because I'm not sure who should be doing the action in the second sentence):
Use the npm package manager for Node-based projects. USWDS maintains the @uswds/uswds package that includes both the pre-compiled and compiled files. You can rely on npm packages to easily update and install the design system from the command line.

Or just
"Developers can rely on npm packages..."

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 sarah-sch changed the title USWDS: Update capitalization of npm In README Bug - USWDS: Update capitalization of npm In README May 3, 2024
@sarah-sch sarah-sch changed the title Bug - USWDS: Update capitalization of npm In README USWDS - Bug: Update capitalization of npm In README May 3, 2024
@sarah-sch sarah-sch added Type: Bug A problem in the code Affects: Content Relates to content labels May 3, 2024
@mahoneycm
Copy link
Contributor

@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:

An introduction to the npm package manager

@amyleadem amyleadem linked a pull request May 7, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Content Relates to content Status: Triage We're triaging this issue and grooming if necessary Type: Bug A problem in the code
Projects
Status: Fed Final Review
Development

Successfully merging a pull request may close this issue.

2 participants