Improving commit logs

[Glen Barber]

On Thu, Apr 14, 2016 at 01:01:02PM +0930, O'Connor, Daniel wrote:
> 
> > On 14 Apr 2016, at 12:58, Glen Barber <gjb at FreeBSD.org> wrote:
> >> Sure, but I think it carries more weight if you can point to a
> >> specific FreeBSD document and say "do it like this".
> > As one of the people that has to suffer through delving through commit
> > logs to find the 'gems', I can personally guarantee that documenting
> > "how to write good commit messages" will be less than fruitful.
> 
> Realistically I don't see this as a magic bullet. IMO the only
> way to enforce good commits is socially - i.e. have other committers
> call people out on bad commit messages in a *constructive* way.
> That is to say, you don't say "your commit message sucks" you say
> "I think it would be helpful if the log explained why this change
> was made".
> 
> I think having a document like this is useful as something to
> point to and a guide for new committers to start from.
> 

I absolutely agree with you that a guide on this will be beneficial.
Sorry if my reply was taken any other way.

If I had a genie in a bottle, my three wishes would be:

1) Better commit messages that address the "what";
2) Better explanation on the "why";
3) More wishes.

Glen

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-hackers/attachments/20160414/d8ebbf17/attachment.sig>