Changes between Version 1 and Version 2 of Development/Commits


Ignore:
Timestamp:
10/30/10 17:40:58 (3 years ago)
Author:
stuge
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/Commits

    v1 v2  
    11= Commit messages = 
    22 
    3 It's important to write good commit messages that will stand the test of time, so that those who review your patches can know what the patch is supposed to do, and so that anyone looking back at the repository history can see what was done. 
     3It's important to write good commit messages that will stand the test of time, so that those who review your patches can know what the patch is supposed to do, and so that anyone looking at the repository history (e.g. when tracking down a regression) can see what was done in the past. 
    44 
    55== General format == 
     
    88Short one line description of commit, preferably <= 60 chars 
    99 
    10 This is line 3 where a long description of the commit can start. The 
    11 description should normally include some background on why this commit 
    12 was required and why it is best that the commit changes things the way 
    13 it does. Lines should preferably be <= 70 characters. Note that line 2 
    14 should be left blank. 
     10This is line 3 where a long description of the commit can start. Line 2 
     11above should always be left blank. The long description should normally 
     12include some background on why this commit was required and why it is 
     13best that the commit changes things the way it does. Lines should 
     14preferably be <= 70 characters. 
    1515}}} 
    1616