Changes between Version 1 and Version 2 of commitmessages


Ignore:
Timestamp:
Sep 18, 2013, 1:15:43 PM (5 years ago)
Author:
matthijs
Comment:

Don't require trailing stops on commit messages anymore

Legend:

Unmodified
Added
Removed
Modified
  • commitmessages

    v1 v2  
    1717
    1818{{{
    19 component: Summary of changes.
     19component: Summary of changes
    2020
    2121Longer description, possible multiple paragraphs.
     
    2727The component prefix is used to note the package or component concerned in the change. This should just be a single word, like "{{{umtsd}}}" or "{{{buildsystem}}}". It helps to look at the svn log for the directory you're working in to keep things consistent with previous commit messages. This prefix can be left out if no relevant component or package applies (for very general changes, for example).
    2828
    29 The summary of changes should focus on ''what'' has changed. It shouldn't be overly long, try to keep the complete line within 80 characters, if possible (but let it extend past the 80 character if needed, don't wrap the first line). Make sure this single sentence, complete with capitalization and a trailing stop.
     29The summary of changes should focus on ''what'' has changed. It shouldn't be overly long, try to keep the complete line within 80 characters, if possible (but let it extend past the 80 character if needed, don't wrap the first line). Make sure this is a single sentence, complete with capitalization (but omit a trailing stop).
    3030
    31 The longer description should contain all of the other info, such as detailed effects and rationale. This description should be wrapped around 70-80 characters and also consist of complete sentences. Multiple paragraphs are separated by blank lines.
     31The longer description should contain all of the other info, such as detailed effects and rationale. This description should be wrapped around 70-80 characters and also consist of complete sentences (including trailing stops). Multiple paragraphs are separated by blank lines.
    3232
    3333Finally, you should reference relevant tickets in the format shown above. Use the Closes command on the commit that actually resolves a ticket and use References on other related tickets (guideline: does the ticket help in understanding the changes made in the commit?).
     
    3636
    3737{{{
    38     umtsd: Remove usb_hotplug.
     38    umtsd: Remove usb_hotplug
    3939   
    4040    This utility has been replaced by a hotplug script shipped with the
     
    4747
    4848{{{
    49     fuse: Update to 2.8.4.
     49    fuse: Update to 2.8.4
    5050   
    5151    This imports the fuse package from OpenWRT trunk (r22919) unmodified.
     
    6262This message is good, since it clearly describes what has changed, including relevant version and revision numbers. It also mentions a potential side-effect that is unexpected from the change itself. It could be slightly improved by including the rationale for the change (but perhaps that's also clarified by the ticket referenced).
    6363{{{
    64     transmission: Update to 2.04.
     64    transmission: Update to 2.04
    6565   
    6666     * Update the crypt patch to apply to 2.04.
     
    8282This message is good, since it contains a complete list of the changes required to get the new version of Transmission working. It also explicitly notes why the OpenWRT version could not be used. This commit could perhaps been improved by splitting it into multiple commits (it's quite a big change), but that might not be practical. Verbosely documenting the separate sub-changes should help a lot in understanding them.
    8383{{{
    84     Make advertisement timeout shorter.
     84    Make advertisement timeout shorter
    8585}}}
    8686This message is bad, since it is entirely unclear. What timeout is concerned here, and why does it need to be shortened?
    8787
    8888{{{
    89     Lots of umts fixes.
     89    Lots of umts fixes
    9090}}}
    9191This message is bad, since it does not provide any details about the changes made or the bugs fixed. The commit it describes is also too big: It contains a number of unrelated changes (translations, packaging, actual code), making it harder to find out why something was changed later on.