[MacPorts] NewCommittersGuide modified

[MacPorts]

Changed page "NewCommittersGuide" by jmr at macports.org from 210.215.87.80*
Page URL: <http://trac.macports.org/wiki/NewCommittersGuide>
Diff URL: <http://trac.macports.org/wiki/NewCommittersGuide?action=diff&version=24>
Revision 24
Comment: specific advice for writing good commit messages

-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: NewCommittersGuide
=========================================================================
--- NewCommittersGuide (version: 23)
+++ NewCommittersGuide (version: 24)
@@ -16,7 +16,10 @@
  1. New top-level categories (those which are represented by subdirectories directly beneath dports/) need to be approved prior to adding; secondary categories (the second and later ones listed on the '''categories''' Portfile key) can be added when it makes sense (since these really only show under the web interface, and do not necessarily have a filesystem representation)
  1. Port directory name has to match the ''name'' option in the Portfile
  1. Run `port lint` before committing to be sure not to violate one of the guidelines
- 1. Commit logs should make clear what has been changed
+ 1. Commit messages should make clear what has been changed:
+  1. Mention the names of the affected ports (or state what they have in common if there are too many to list individually), since this information is not visible in the revision log
+  1. Be specific about what changes were made (for example, when updating to a new upstream version, mention the version number) and, if it's not completely obvious, why they were made
+  1. Reference any tickets that are related to the change, preferably with a [wiki:TracLinks Trac link]
  1. Under most circumstances, do not modify a port belonging to another maintainer; this is to be done either via a Trac ticket or by direct communication with the maintainer.  Exceptions are:
    1. When a port is broken (and the update should be just to fix the port, no other updates "while you're there")
    1. When ''nomaintainer at macports.org'' is the maintainer; this really means the port is unowned (feel free to take it over)

-------8<------8<------8<------8<------8<------8<------8<------8<--------

* The IP shown here might not mean anything if the user or the server is
behind a proxy.

--
MacPorts <http://www.macports.org/>
Ports system for Mac OS

This is an automated message. Someone at http://www.macports.org/ added your email
address to be notified of changes on NewCommittersGuide. If it was not you, please
report to .