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

fix(ui): Capitalization, punctuation, and grammar inconsistences & errors #731

Merged
merged 6 commits into from
Jan 26, 2021
Merged

fix(ui): Capitalization, punctuation, and grammar inconsistences & errors #731

merged 6 commits into from
Jan 26, 2021

Conversation

TheCatLady
Copy link
Collaborator

@TheCatLady TheCatLady commented Jan 24, 2021

@sct: I understand this is a huge PR that touches a ton of files, so I totally understand if you don't want to accept it, but I figured I'd try before the project got any bigger.

Description

I have OCD and inconsistencies and errors really bother me. I feel that especially as Overseerr matures, we need a style guide for UI text. The codebase is uniformly/consistently formatted, so let's make the UI that way as well!

I propose that:

  • Appropriate Unicode characters are used for ellipses, arrows, etc.
  • Proper nouns (Plex, Radarr, Sonarr, Telegram, Slack, Pushover, etc.) are capitalized
  • Headings, button text, and form labels are title case (verbs like "is" should be capitalized, whereas prepositions like "from" should not)
  • First letter is capitalized in validation error messages, dropdowns, and form "tips"
  • Toast notifications are complete sentences ending in some form of punctuation
  • If an additional description/"tip" is required for a field, it should be separate from the main label
  • In full sentences, abbreviations like "info" or "auto" should not be used in place of full words, unless referencing the name/label of a setting/option which has an abbreviation
  • Since a decision was made to use "sign in/out" in another PR, let's be consistent and not use "log in/out" verbiage
  • Correct capitalization is used for the names of metadata databases... TMDb and IMDb officially have a lowercase 'b', while TVDB has a capital 'B' (infuriating, I know, but let's stick with what's official!)
  • There are no grammatical mistakes (of course)
  • Oxford comma is used where appropriate
  • Be concise and clear, using as few words as possible to make your point
  • "Overseerr" is not misspelled 🤦🏻‍♀️ (...and it should be capitalized since it's a proper noun!)

If there are any other issues that I didn't catch, please let me know and I can add them to this PR. 😺

And I'd be happy to help proofread/review any PRs that introduce new UI strings going forward; just tag me!

Screenshot (if UI related)

Example:
image

@TheCatLady TheCatLady changed the title Fix capitalization, punctuation, and grammar inconsistences & errors fix(ui): Capitalization, punctuation, and grammar inconsistences & errors Jan 24, 2021
@lgtm-com
Copy link

lgtm-com bot commented Jan 24, 2021

This pull request introduces 1 alert when merging 6c04b6b into 2f75c4c - view on LGTM.com

new alerts:

  • 1 for Unused variable, import, function or class

@spylex
Copy link

spylex commented Jan 24, 2021

Purely from an effort perspective and for neatness i suggest this gets merged, and TheCatLady onboarded as official formatting guru!

@TheCatLady TheCatLady marked this pull request as draft January 24, 2021 00:48
@TheCatLady TheCatLady marked this pull request as ready for review January 24, 2021 01:01
@sct sct merged commit f05d4a0 into sct:develop Jan 26, 2021
@TheCatLady TheCatLady deleted the fix-caps-punct-grammar branch January 26, 2021 23:35
@github-actions
Copy link

🎉 This PR is included in version 1.18.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants