Overview
| Artifact ID: | e5191ff67bc295ec34f19e2d492d851121eb05bf208d79d9c8780dc4240c77e5 |
|---|---|
| Page Name: | Style Guide |
| Date: | 2018-08-05 21:03:45 |
| Original User: | joel |
| Next | 917f909f8919b2bfc71ae524fcce02edf9574f1ddf6772e07f8e254d22af145e |
Content
Commit messages
- Commit messages should use the imperative voice.
- Commit messages should be no more than ≈ 50 characters long.
- If more explanation is needed, create a ticket and cross-reference it with the commit message.
- Comments added to tickets in connection with a resolving check-in should describe why the change was made, not how (the code does that part already).
Prose
- The Local Yarn should be italicized.
- The Local Yarn is emphatically not “a web site”.
Punctuation
- In a list of actions, list items should end with a period.
- In a list of things, list items should not end with a period.
- Place trailing commas and periods outside of quotation marks unless they are part of the quoted text.