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

Changes to "Style Guide" between 2018-08-05 21:03:45 and 2018-08-06 18:40:58

1
2

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17





















1




2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
-
-
+
-
-
-
-











+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<h2>Commit messages</h2>

These are notes for my own use.
  *  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.

<h2>Source files</h2>

  *  Header comment includes copyright notice, license information, and author contact info.
  *  (Racket) All comments on their own line begin with <code>;;</code>

<h2>Pre-commit checklist</h2>

  #  Run <code>fossil diff --tk</code> to ensure all edits are related.
  #  Run <code>fossil changes --differ</code> to ensure no extra files need to be added.
  #  If any files have been added with <code>fossil add</code> ensure the makefile is up to date.
  #  Make sure you’re on the correct branch.

<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).