Changes between Version 25 and Version 26 of CommitMessages

Timestamp:

Sep 16, 2019, 6:37:40 AM (5 years ago)

Author:

jmroot (Joshua Root)

Comment:

--

CommitMessages

@@ -10 +10 @@
   - **Include the most important information.** Don't assume that readers can see the entire commit message; subjects often appear in isolation (e.g., GitHub history listings, `git log --oneline`, `git shortlog`).
   - **Be specific.** Avoid vague subjects like "Update to latest version" or "Fix the build". For example, if you are updating a port to a new upstream version, mention the version number.
-  - **List any modified ports first**, followed by a colon (e.g., "autoconf, libtool:"). To save space, you can use glob notation (e.g., "[[span(py3*-numpy:, style=white-space: nowrap)]]", "[[span(clang-3.![6-9]:, style=white-space: nowrap)]]") or describe the ports' commonality (e.g., "boost dependents:").
+  - **List any modified ports.** A good way to do this is to put their names first, followed by a colon (e.g., "autoconf, libtool:"). To save space, you can use glob notation (e.g., "[[span(py3*-numpy:, style=white-space: nowrap)]]", "[[span(clang-3.![6-9]:, style=white-space: nowrap)]]") or describe the ports' commonality (e.g., "boost dependents:").
   - **Try to use no more than 50–55 characters**, and treat 60 characters as a hard maximum. Feel free to shunt minor changes down to the message body. If you are having serious trouble meeting these limits, consider breaking up the commit into smaller pieces that are easier to describe.
 1. **Blank line.** Separate the subject from the body with a blank line; otherwise tools that parse Git history will get confused. Plus, it looks better.