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

docs: add lists section to styleguide #62

Closed
wants to merge 4 commits into from
Closed

docs: add lists section to styleguide #62

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
199c947
docs: Added lists section to styleguide
ryan-blunden Nov 26, 2018
5edb7db
docs: fixed typos
ryan-blunden Nov 26, 2018
f963938
Update STYLEGUIDE.md
ryan-blunden Nov 28, 2018
0af6e9e
docs: added extensions-hacky-hour event
ryan-blunden Dec 4, 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
Next Next commit
docs: Added lists section to styleguide
  • Loading branch information
@ryan-blunden
ryan-blunden committed Nov 26, 2018
commit 199c947357969bcc0c75547b52195dc3228577aa
16 changes: 16 additions & 0 deletions STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,22 @@ Never use any of the following as link text:
- instructions
- these instructions

### Lists

#### Introductory sentances

Lists should begin with an introductory sentence. The sentence should end with a colon unless there is other content, such as an image or admonition between the introductory sentence and the list.

#### Punctuation and capitalization

Each list item should begin with a capital letter.
ryan-blunden marked this conversation as resolved.
Show resolved Hide resolved

Each list item should end with a period or other appropriate sentence-ending punctuation, except:

- If the item is a single word.
- If the item doesn't include a verb.
- If the item is a code snippet.

### Instructions, references, and citations

Render references to UI text in bold. Match the actual case of the UI text in other products even if it violates our style guide.
Expand Down