Skip to content

Updating title case to sentence case and other conventions #15285

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
Merged
merged 1 commit into from
Aug 8, 2022
Merged

Updating title case to sentence case and other conventions #15285

merged 1 commit into from
Aug 8, 2022

Conversation

@georgewrmarshall
Copy link
Contributor

@georgewrmarshall georgewrmarshall commented Jul 19, 2022 •
edited
Loading

Explanation

Currently, we are inconsistent with our content casing conventions across the app.

This is a problem because although subtle it causes inconsistencies across our app and impacts our brand, accessibility and the message we convey to our users.

In order to solve this problem, this pull request updates all EN content to use sentence case with some exceptions and updates some other conventions.

Exceptions to sentence case

Names, companies, abbreviations or nouns
e.g. “MetaMask”, “OpenSea”, “Google Chrome”, “Ledger Live”, “NFT”, “API”

Special terms
e.g. “Secret Recovery Phrase”, "Private Key"
"Secret Recovery Phrase' and "Private Key" an extremely important concepts that are critical to preventing users losing their funds. To convey the importance of these terms, they use title case.

Page navigation
When referring to the navigation route in the app we quote the page as its title appears e.g.

  • "You can enable Ledger Live support by clicking Settings > Advanced > Use Ledger Live.”
  • "Go to Settings > Advanced”
  • “Go to Settings > Network and enter the chain ID. You can find the chain IDs of most popular networks on $1”

Reference

Screen Shot 2022-07-19 at 1 46 21 PM

Other content
Other content which may raise questions as to whether they should be capitalized and that should also follow the sentence case convention include:

More Information

Manual Testing Steps

This touches a lot of content so I would suggest just looking at the code changes to see if the conventions are correct.

  • Only app/_locales/en/messages.json in locals needs to be thoroughly scrutinized. All other local files are description updates that were updated automatically using yarn verify-locales:fix
  • Because this PR touches a lot of text and we use text to find nodes for e2e testing there are a lot of e2e test updates.
  • No other content should be changed apart from the casing and conventions mentioned above.

Pre-Merge Checklist

  • PR template is filled out
  • IF this PR fixes a bug, a test that would have caught the bug has been added N/A
  • PR is linked to the appropriate GitHub issue
  • PR has been added to the appropriate release Milestone N/A

+ If there are functional changes:

  • Manual testing complete & passed N/A
  • "Extension QA Board" label has been applied N/A

@georgewrmarshall georgewrmarshall requested a review from a team as a code owner July 19, 2022 20:43
@github-actions
Copy link
Contributor

github-actions bot commented Jul 19, 2022

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@georgewrmarshall georgewrmarshall requested review from bschorchit and rachelcope and removed request for PeterYinusa July 19, 2022 20:44
@georgewrmarshall georgewrmarshall self-assigned this Jul 19, 2022
@georgewrmarshall georgewrmarshall added the team-design-system All issues relating to design system in Extension label Jul 19, 2022
@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch from b5f1003 to 31ccfe4 Compare July 19, 2022 20:51
@georgewrmarshall
Copy link
Contributor Author

georgewrmarshall commented Jul 19, 2022 •
edited
Loading

@coreyjanssen I can't seem to tag you as a reviewer but please review none the less 👀 😄 I'll see if I can get that set up.

@georgewrmarshall georgewrmarshall mentioned this pull request Jul 19, 2022
Open
@georgewrmarshall georgewrmarshall dismissed a stale review via fd095ba July 21, 2022 21:30
@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch from bc216d2 to fd095ba Compare July 21, 2022 21:30
coreyjanssen
coreyjanssen previously approved these changes Jul 21, 2022
View reviewed changes
Copy link
Contributor

@coreyjanssen coreyjanssen left a comment

Choose a reason for hiding this comment

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

approved by content design!

@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch from fd095ba to 56cadf7 Compare July 22, 2022 17:44
@georgewrmarshall georgewrmarshall dismissed a stale review via a15fbf9 July 26, 2022 21:49
@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch 2 times, most recently from b1ad231 to 7f79ee3 Compare July 27, 2022 22:25
@georgewrmarshall georgewrmarshall dismissed a stale review via 599c6e0 August 3, 2022 15:27
@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch 2 times, most recently from 599c6e0 to 0528f05 Compare August 3, 2022 15:28
georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/de/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/el/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/es/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/es_419/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/fr/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/hi/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/id/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/ja/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/ko/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/pt/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/ru/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/tl/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/vi/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

georgewrmarshall
georgewrmarshall commented Aug 3, 2022
View reviewed changes
app/_locales/zh_CN/messages.json Outdated
Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

auto updating descriptions using yarn verify-locales:fix

@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch 4 times, most recently from a931391 to d98c27e Compare August 3, 2022 22:37
@georgewrmarshall georgewrmarshall force-pushed the fix/15039/sentence-case branch from d98c27e to a194ec2 Compare August 3, 2022 23:24
@metamaskbot
Copy link
Collaborator

metamaskbot commented Aug 4, 2022

Builds ready [a194ec2]
Page Load Metrics (1734 ± 35 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint88131102126
domContentLoaded1541181917266732
load1541187917347235
domInteractive1541181917266732

highlights:

storybook

brad-decker
brad-decker suggested changes Aug 4, 2022
View reviewed changes
app/_locales/en/messages.json
},
"QRHardwareSignRequestGetSignature": {
"message": "Get Signature"
"message": "Get signature"
Copy link
Contributor

@brad-decker brad-decker Aug 4, 2022

Choose a reason for hiding this comment

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

@adonesky1 et @Gudahtt I apologize for my ignorance but could you school me on how the new transaltion system works? Will these changes be picked up and retroactively applied to all languages?

Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 4, 2022

Choose a reason for hiding this comment

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

Oh that's a great question! I was fully prepared to create more PRs to cover all the other locales. If there is an automated process or some way to delegate that task it would make my day.

Copy link
Contributor Author

@georgewrmarshall georgewrmarshall Aug 8, 2022

Choose a reason for hiding this comment

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

Just posting @rickycodes slack DM here for reference

Will these changes be picked up and retroactively applied to all languages?
yes! once the change is merged in, Blend will be notified via the crowdin integration and a follow up PR should be opened by crowdin once their aforementioned updates are ready

Copy link
Contributor

@adonesky1 adonesky1 Aug 8, 2022

Choose a reason for hiding this comment

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

@brad-decker can you explain what you mean by "retroactively applied to all languages"?

@georgewrmarshall georgewrmarshall merged commit 0692f7b into develop Aug 8, 2022
@georgewrmarshall georgewrmarshall deleted the fix/15039/sentence-case branch August 8, 2022 19:01
@github-actions github-actions bot locked and limited conversation to collaborators Aug 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@adonesky1 adonesky1 adonesky1 left review comments

@NidhiKJha NidhiKJha NidhiKJha approved these changes

@coreyjanssen coreyjanssen coreyjanssen approved these changes

@bschorchit bschorchit Awaiting requested review from bschorchit

@garrettbear garrettbear Awaiting requested review from garrettbear

+1 more reviewer

@brad-decker brad-decker brad-decker approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@georgewrmarshall georgewrmarshall

Labels

team-design-system All issues relating to design system in Extension

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update settings page to use sentence casing for titles.

7 participants

@georgewrmarshall @metamaskbot @brad-decker @adonesky1 @NidhiKJha @coreyjanssen