[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [E-devel] A quick, friendly plea for useful commit logs.



On Mon, 3 Apr 2006 19:47:02 -0500 Brian Mattern <brian.mattern@gmail.com>
babbled:

> mekius++
> 
> > Enlightenment CVS committal
> >
> > Author  : mekius
> > Project : e17
> > Module  : proto
> >
> > Dir     : e17/proto/empower/src
> >
> > Added Files:
> > 	Makefile.am
> >
> > Log Message:
> > Initial import of empower, a graphical sudo program
> 
> kiwi--
> 
> > Enlightenment CVS committal
> > 
> > Author  : kiwi
> > Project : e_modules
> > Module  : devian
> > 
> > Dir     : e_modules/devian/src
> > 
> > Added Files:
> >         Makefile.am 
> > 
> > Log Message:
> > Initial commit for dEvian module
> 
> 
> The fact that e_modules/devian was added by this commit tells me everything 
> that the log message does. Nothing here says anything about what dEvian IS 
> though (or why we should take the time to compile it and try it out).
> 
> In general, I think it would help if we came up with some better guidelines 
> for CVS commit messages (to help facilitate intra-project communication a 
> bit). Something simple, along the lines of.
> 
> A) On initial import, say what the thing does.
> B) For everything else, write a short descriptive sentence about what the 
> commit changes / fixes. Include any extra detail you want to on the 
> subsequent lines.
> 
> Oh, and "bleh--" IS about as descriptive as you can get when you really are 
> just removing a printf("bleh\n"); line :)

agreed - for big imports - at least say what the thing is - what it does. for
small commits - the diff is in the mail. so removing some printfs is plain
obvious when u take a quick look at the tiny diff. the important bit though is
to let people know what you are doing a little more than assuming they know
what "devian" is. :)

-- 
------------- Codito, ergo sum - "I code, therefore I am" --------------
The Rasterman (Carsten Haitzler)    raster@rasterman.com
裸好多
Tokyo, Japan (東京 日本)