[MacPorts] CommitRules added

[MacPorts]

Page "CommitRules" was added by mk at macports.org
Comment: Formulate rule for commit messages to MacPorts' SVN repo
Content:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
== Commit Rules ==

=== Using sensible commit messages ===

When committing your changes to MacPorts' central port tree using subversion it is good practice to use properly formatted commit messages.

Think about others reading the [https://trac.macports.org/timeline timeline]. Here you want to see on first glance which port got modified, therefore the required format for commit messages is this:
{{{
PORTNAME: COMMENT
}}}
Here a reader of MacPorts' timeline can see quickly get the most important information, i.e. WHICH port got changed WHY.

A real-life example is:
{{{
devel/zmq: Fix build on darwin <= 10, closes #40663
}}}
Note that references to [https://trac.macports.org/wiki/Tickets trac tickets] can be inserted using the '#' as well as references to certain commits of the MacPorts repository by using 'r' (e.g. r111866).
-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://trac.macports.org/wiki/CommitRules>
MacPorts <http://www.macports.org/>
Ports system for OS X

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