Re: Git commit methodology

[Ted Zlatanov <tzz@lifelogs.com>]

On Mon, 30 Aug 2010 15:38:33 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Ted Zlatanov <tzz@lifelogs.com> writes:
>> The ChangeLog format is the same.  The *commit message* should be
>> 
>> --cut--
>> short-description-of-change
>> 
>> normal-commit-message
>> --cut--
>> 
>> which produces nice one-line summaries in the condensed git log (and
>> Bazaar).

LMI> Ah, right.  Has anybody done any ChangeLog/vc log integration?  I mean,
LMI> if I'm checking in a change set that includes the ChangeLog, then it
LMI> would make sense to default the text to text extracted from the
LMI> ChangeLog.

LMI> That is, if the ChangeLog text about to be checked in is:

LMI> -------
LMI> 2010-08-29  Lars Magne Ingebrigtsen  <larsi@gnus.org>

LMI> 	* gnus-start.el (gnus-dribble-read-file): Ensure that the directory
LMI> 	where the dribbel file lives exists.
LMI> -------

LMI> then the vc log buffer could be populated with:

LMI> -------
LMI> Ensure that the directory where the dribble file lives exists.
LMI> -------

This works for a one-sentence commit, but generally it doesn't.  The
summary should be very succinct and ChangeLog messages tend to be
explicit and long.  I think it's better to type the summary manually,
unless the one-sentence match works.  I don't think anyone has done work
on this but it does sound useful.

LMI> (Note how the code also fixed up the typo automatically.  :-)

I'd rather see it introduce typos automatically.  Then no one will ever
know you screwed up :)

Ted