D 2018-08-26T18:12:08.427 L Style\sGuide P 917f909f8919b2bfc71ae524fcce02edf9574f1ddf6772e07f8e254d22af145e U joel W 1654 These are notes for my own use.

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.

Source files

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

Pre-commit checklist

# Run fossil changes --differ to ensure no extra files need to be added. # Run fossil diff --tk to ensure all edits are related. # If any files have been added with fossil add, 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.

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. * Link a commit to a related ticket by using brackets [ ] containing at least the first 6 digits of the UUID. * 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). Z 4cc5c3f344771d002cdb3c9ea1fe582f