D 2018-08-26T18:12:08.427
L Style\sGuide
P 917f909f8919b2bfc71ae524fcce02edf9574f1ddf6772e07f8e254d22af145e
U joel
W 1654
These are notes for my own use.
<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 changes --differ</code> to ensure no extra files need to be added.
# Run <code>fossil diff --tk</code> to ensure all edits are related.
# If any files have been added with <code>fossil add</code>, ensure the makefile is up to date.
# Ideally, any documentation (Scribble files) should be updated at the same time as the source code.
# 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.
* Link a commit to a related ticket by using brackets <code>[ ]</code> containing at least the first 6 digits of the UUID.
* 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).
Z 4cc5c3f344771d002cdb3c9ea1fe582f
