Changes between Version 23 and Version 24 of NewCommittersGuide


Ignore:
Timestamp:
Aug 27, 2010, 11:28:45 AM (14 years ago)
Author:
jmroot (Joshua Root)
Comment:

specific advice for writing good commit messages

Legend:

Unmodified
Added
Removed
Modified
  • NewCommittersGuide

    v23 v24  
    1717 1. Port directory name has to match the ''name'' option in the Portfile
    1818 1. Run `port lint` before committing to be sure not to violate one of the guidelines
    19  1. Commit logs should make clear what has been changed
     19 1. Commit messages should make clear what has been changed:
     20  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
     21  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
     22  1. Reference any tickets that are related to the change, preferably with a [wiki:TracLinks Trac link]
    2023 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:
    2124   1. When a port is broken (and the update should be just to fix the port, no other updates "while you're there")