[guardian-dev] git commit messages

Hans-Christoph Steiner hans at at.or.at
Thu Dec 1 13:15:21 EST 2011


I just saw this description of how to write a git commit message for GnuPG and I thought it make a lot of sense:

 Your commit log should always start with a one-line summary, the second
 line should be blank, and the remaining lines are usually ChangeLog-style
 entries for all affected files.  However, it's fine -- even recommended --
 to write a few lines of prose describing the change, when the summary
 and ChangeLog entries don't give enough of the big picture.  Omit the
 leading TABs that you're used to seeing in a "real" ChangeLog file, but
 keep the maximum line length at 72 or smaller, so that the generated
 ChangeLog lines, each with its leading TAB, will not exceed 80 columns.

.hc


----------------------------------------------------------------------------

I have always wished for my computer to be as easy to use as my telephone; my wish has come true because I can no longer figure out how to use my telephone."  --Bjarne Stroustrup (creator of C++)



More information about the Guardian-dev mailing list