Changes between Version 22 and Version 23 of NewCommittersGuide

Timestamp:

Apr 1, 2010, 2:54:15 PM (14 years ago)

Author:

raimue (Rainer Müller)

Comment:

Port directory, there are no commit log templates

NewCommittersGuide

@@ -15 +15 @@
  1. Make whitespace changes in a separate commit. To keep diffs readable for review whitespace changes should be done in a separate commit without any functional changes.
  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. Make sure the port name matches between the MacPorts svn directory name and the '''name''' Portfile key (while the system works fine when they don't, keeping them synchronized avoids confusing situations)
+ 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. Should commit logs finally be standardized?  The output is shown in various places and forms: trac, RSS, email, [http://cia.vc/ CIA] stuff; some of these may just use the first line
+ 1. Commit logs should make clear what has been changed
  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@macports.org'' is the maintainer; this really means the port is unowned (feel free to take it over)
    1. When ''openmaintainer@macports.org'' is co-maintainer; this signifies that the primary maintainer has no prior objections to others changing it
-   1. When the maintainer says the update is okay and asks you to commit your update; in this case, be sure to note in the commit message that it was '''Approved by:''' the maintainer (see the bit about commit log entries above)
+   1. When the maintainer says the update is okay and asks you to commit your update; in this case, be sure to note in the commit message that it was approved by the maintainer
    1. When a ticket was already filed and you're making use of the [http://guide.macports.org/#project.update-policies.nonmaintainer maintainer timeout], note this fact in your commit message and add the ticket id for reference.
  1. Set up automatic properties for Subversion, as described on the [wiki:CommittersTipsAndTricks#SetsvnpropertiesautomaticallyonnewPortfiles Committers Tips and Tricks] wiki page.