On 03/12/13 18:58, Iván Briano wrote: > On Tue, Dec 3, 2013 at 3:10 PM, Stefan Schmidt > <ste...@datenfreihafen.org> wrote: >> Hello. >> >> On Mon, 2013-12-02 at 11:02, Stefan Schmidt wrote: >>> >>> Please be aware that we don't want to update NEWS and Changelog with >>> every commit in this cycle anymore. I have just seen some commits >>> doing that. They only copy the commit subject into two more files. >>> >>> I will go through the commit log before cutting tarballs and update >>> them accordingly. So please put your energy into writing good commit >>> messages instead of updating two moe files with the same content. >> >> Seems people are still struggling what I expect from them in the >> commit message to make my life easier. >> >> I don't have a template for you as I don't want to cut down your >> creativity. :) What I can give you is a few questions you can ask >> yourself when writing it. >> >> o Is it a bug fix? If yes please mention this somehow in the commit >> message e.g. evas: Fix length check to avoid slow path in evas line >> That would perfectly indicate to me that this is a bug fix. >> >> o Does the bug have a phab ticket? (It should) Please mention the phab >> ticket number. Same for the coverity ID. >> >> o Bug fixes for features that just merged in this cycle are good but >> long standing bugs from older releases are more important to get >> mentioned. >> >> o For bigger features which might span over several patches I really >> would appreciate a good high level description that goes either >> directly into the release notes wiki page or in one of the first >> commits. If you do the later please point this out to me so I can >> bring it over to the release note page. (Hint: Directly put it into >> the wiki makes both our life easier.) >> >> Thats is for now. Once I find more problems I will let you know. For >> now I would like to keep this lean and grow more naturally. >> > > If I may add, commit messages that describe obvious code don't help, > but adding the reason why the change matters does. So don't just describe > what you did, but tell us why, what was the problem, why did that part > of the code > caused it, why does your change fix it. > > This helps also not only to review the actual patch but to find out if the fix > is the best we can come up with, or if maybe it's not the right fix > but it's covering > a deeper problem.
Yes, I hate those commit messages! "Added an if to check some-crazy-shit is equal to 8 in some-other-crazy-shit." -- Tom. ------------------------------------------------------------------------------ Sponsored by Intel(R) XDK Develop, test and display web and hybrid apps with a single code base. Download it for free now! http://pubads.g.doubleclick.net/gampad/clk?id=111408631&iu=/4140/ostg.clktrk _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
