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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update style guide for OSS #19

Merged
merged 8 commits into from
Oct 16, 2018
Merged

Update style guide for OSS #19

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
59d057f
Move styleguide.md to root directory
Oct 10, 2018
7870861
Update styleguide to sentence case
Oct 10, 2018
0c6daa9
Update styleguide for OSS release
Oct 10, 2018
c955ad6
Update reference to OSS
Oct 10, 2018
04d7c8c
Updates
Oct 16, 2018
2a31592
Update wording
Oct 16, 2018
79cc86f
Update OSS and extensions callout
Oct 16, 2018
bcaa40a
Remove devops/admin
attfarhan Oct 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update styleguide to sentence case
  • Loading branch information
Francis Schmaltz committed Oct 10, 2018
commit 7870861e5472c444a987bc3694d43e3de7994a46
3 changes: 1 addition & 2 deletions STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ Our copy should be:
## General

- Seek to make content available, and coherent, to all peoples.
- Use Title Case for headers, buttons, features, and short lists.
- Use sentence case for non-header text. When sentence case is used, full punctuation should be used.
- Use sentence case for all text. When sentence case is used, full punctuation should be used.
Copy link
Member

Choose a reason for hiding this comment

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

Full punctuation (periods, etc.) should not be used in many cases: buttons, labels, nav links, headlines, etc. I think you can just omit the "When sentence case is used, full punctuation should be used." sentence and it will be clear.

Copy link
Member

Choose a reason for hiding this comment

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

BTW, the model for us to follow is GitHub. They have very consistent style in all their pages and materials, and they use sentence case. If in doubt about a rule, look at what GitHub does.

- Render proper nouns as their creators prefer ("GitHub" not "Github").
- Punctuation goes outside of quotation marks, except in marketing when displaying a quote.
- Use the most popular US English spelling and phrasing.
Expand Down