Page "CommitRules" was changed by ryandesign@macports.org Diff URL: <https://trac.macports.org/wiki/CommitRules?action=diff&version=3> Revision 3 Changes: -------8<------8<------8<------8<------8<------8<------8<------8<-------- Index: CommitRules ========================================================================= --- CommitRules (version: 2) +++ CommitRules (version: 3) @@ -4,14 +4,16 @@ 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: +Think about others reading the [/timeline timeline]. Here you want to see on first glance which port got modified, therefore the recommended format for commit messages is this: {{{ PORTNAME: COMMENT }}} -Here a reader of MacPorts' timeline can quickly get the most important information, i.e. WHICH port got changed and WHY. +Here a reader of MacPorts' timeline can quickly get the most important information, i.e. ''which'' port got changed and ''why''. A real-life example is: {{{ -devel/zmq: Fix build on darwin <= 10, closes #40663 +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). +Note that references to [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). + +If a change affects multiple ports, list all affected ports. If a change affects a large number of ports, listing their names is not necessary. -------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 .