[MacPorts] CommitMessages modified

MacPorts noreply at macports.org
Sun Nov 6 05:37:29 CET 2016


Page "CommitMessages" was changed by larryv
Diff URL: <https://trac.macports.org/wiki/CommitMessages?action=diff&version=12>
Revision 12
Comment: don't imply atomicity, although that would be nice
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: CommitMessages
=========================================================================
--- CommitMessages (version: 11)
+++ CommitMessages (version: 12)
@@ -10,7 +10,7 @@
   - **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:").
-  - **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 more atomic pieces that are easier to describe.
+  - **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.
 1. **Body.** Use the rest of the commit message to provide context for your changes.
   - **Say what the commit itself cannot.** What was the previous behavior, and why was it wrong or suboptimal? How does your commit change that, and why did you choose this particular approach? Don't just translate the commit diff into English. (However, some context is understood and need not be pointed out explicitly. For example, we assume that updating a port is desirable. You do not have to describe the deficiencies of the old version and improvements of the new.)
-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://trac.macports.org/wiki/CommitMessages>
MacPorts <https://www.macports.org/>
Ports system for macOS

This is an automated message. Someone added your email address to be
notified of changes on 'CommitMessages' page.
If it was not you, please report to admin at macports.org.


More information about the macports-changes mailing list