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

USWDS - README: Update capitalization of npm #5915

Merged
merged 1 commit into from
May 22, 2024
Merged

USWDS - README: Update capitalization of npm #5915

merged 1 commit into from
May 22, 2024

Conversation

mahoneycm
Copy link
Contributor

@mahoneycm mahoneycm commented May 6, 2024 •
edited by amyleadem

Summary

Updated npm references to improve lowercase consistency.

Breaking change

This is not a breaking change.

Related issue

Closes #5876

Preview link

README preview →

Site preview →

Problem statement

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.

Solution

Update references in README to follow the recommended presentation of npm

Testing and review

  1. Review content change to ensure clarity
  2. Review README and site previews and confirm the change looks appropriate
  3. Confirm there are no other capitalized references to npm in any user facing files.

@mahoneycm mahoneycm mentioned this pull request May 6, 2024
Draft
@mahoneycm mahoneycm marked this pull request as ready for review May 6, 2024 20:22
sarah-sch
sarah-sch approved these changes May 6, 2024
View reviewed changes
Copy link

@sarah-sch sarah-sch left a comment

Choose a reason for hiding this comment

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

Thank you, @mahoneycm. The changes look good, and I didn't find any instances of "npm" with inappropriate capitalization on either page.

amyleadem
amyleadem approved these changes May 7, 2024
View reviewed changes
Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Looks good to me! I did not see any other references to npm at the start of sentences in the README. I also confirmed that the updates make sense.

@amyleadem amyleadem requested a review from thisisdano May 7, 2024 16:36
This was referenced May 7, 2024
Draft
Open
@thisisdano thisisdano merged commit 97cc1b9 into develop May 22, 2024
5 checks passed
@thisisdano thisisdano deleted the cm-update-npm-references branch May 22, 2024 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thisisdano thisisdano thisisdano approved these changes

@amyleadem amyleadem amyleadem approved these changes

@sarah-sch sarah-sch sarah-sch approved these changes

@mejiaj mejiaj Awaiting requested review from mejiaj

@finekatie finekatie Awaiting requested review from finekatie

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

USWDS - Bug: Update capitalization of npm In README
4 participants
@mahoneycm @thisisdano @amyleadem @sarah-sch