19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
-
+
|
* (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.
# Ideally, any documentation (Scribble files) should be updated at the same time as the source code. If any <code>.scrbl</code> files have changed, run <code>make scribble</code> to ensure the documentation compiles and is published to this repo.
# 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).
|
