[MacPorts] CommitMessages modified

MacPorts noreply at macports.org
Sat Sep 16 16:08:14 UTC 2017

Page "CommitMessages" was changed by raimue
Diff URL: <https://trac.macports.org/wiki/CommitMessages?action=diff&version=23>
Revision 23
Comment: Recommend use of full URLs
Index: CommitMessages
--- CommitMessages (version: 22)
+++ CommitMessages (version: 23)
@@ -14,8 +14,7 @@
 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 incorrect 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. For example, we assume that updating a port to a new upstream version is beneficial. You do not have to describe the deficiencies of the old version and benefits of the new one.)
-  - **Use full Trac URLs.** TracLinks do not work on GitHub (obviously), so refer to Trac tickets by URL instead of number (e.g., "!https://trac.macports.org/ticket/12345" instead of "!#12345").
-  - **Use autolinked references** to refer to GitHub resources. The website [https://help.github.com/articles/autolinked-references-and-urls automatically links] "#//n//" to pull requests and [[span(SHA-1, style=white-space: nowrap)]] hashes to commits.
+  - **Use full URLs.** TracLinks do not work on GitHub (obviously), so refer to Trac tickets by URL instead of number (e.g., "!https://trac.macports.org/ticket/12345" instead of "!#12345"). To refer to GitHub resources, you may use the [https://help.github.com/articles/autolinked-references-and-urls shorter syntax] such as "#//n//" for pull requests, but the full URL is less ambiguous and makes it easier to follow when viewing `git log` on the command line. The GitHub web interface will always display links to its own resources in the short syntax anyway. For references to commits, use [[span(SHA-1, style=white-space: nowrap)]] hashes.
   - **Wrap body text at 72 characters.** Git does not do this automatically, so hard-wrap the body to prevent text from overflowing standard-width terminal emulators. This also ensures that the output of `git format-patch` adheres to [http://www.openbsd.org/mail.html#Netiquette good email etiquette]. (You can't do much about very long URLs, unfortunately.)
 [https://github.com/macports/macports-ports/commit/d9450d6155ebb83fa8789172502bf2ce2740f77e An example]:

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