Changes between Version 2 and Version 3 of CommitMessages


Ignore:
Timestamp:
Oct 4, 2013, 6:21:24 PM (11 years ago)
Author:
ryandesign (Ryan Carsten Schmidt)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CommitMessages

    v2 v3  
    55When committing your changes to MacPorts' central port tree using subversion it is good practice to use properly formatted commit messages.
    66
    7 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:
     7Think 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:
    88{{{
    99PORTNAME: COMMENT
    1010}}}
    11 Here a reader of MacPorts' timeline can quickly get the most important information, i.e. WHICH port got changed and WHY.
     11Here a reader of MacPorts' timeline can quickly get the most important information, i.e. ''which'' port got changed and ''why''.
    1212
    1313A real-life example is:
    1414{{{
    15 devel/zmq: Fix build on darwin <= 10, closes #40663
     15zmq: Fix build on darwin <= 10, closes #40663
    1616}}}
    17 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).
     17Note 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).
     18
     19If a change affects multiple ports, list all affected ports. If a change affects a large number of ports, listing their names is not necessary.