◊(Local Yarn Code "Changes To Style Guide")

Initial version of "Style Guide"


















1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<h2>Commit messages</h2>

  *  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 <em>why</em> the change was made, not <em>how</em> (the code does that part already).

<h2>Prose</h2>

  *  <i>The Local Yarn</i> should be italicized.
  *  <i>The Local Yarn</i> is emphatically not “a web site”.

<h2>Punctuation</h2>

  *  In a list of <em>actions</em>, list items should end with a period.
  *  In a list of <em>things</em>, 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.