On Sun, Jul 29, 2012 at 6:04 PM, Hartmut Goebel <h.goebel@crazy-compilers.com> wrote:

I would like to ask you to write more meaninfful commit messages.

Currently messages are like:
  • Fix : get back tests like before.
  • Fix : regression Fix #478
  • Just restore a beginning of file to fit old numbers of line and avoid repositionning all following lines. Yeah it is a quite long commit log message :p
  • Add : something very very very .... not important.
I'm wondering what these commits are doing any why. (The last one is really bad: The commit is simply adding another easter-egg.) In the git-world, it's common to use the first line as a summary and add details behind. So you are nor restricted to a single line :-)

Good commit messages are important. They tell others why you did the changes you did, not just right here and now, but months or years from now when someone wonders why some seemingly illogical or inefficient piece of code snuck into your source file. It is also an invaluable aid to deciding which changes to back-port merge from the development branch to the release-branch and which not.

Thus I ask you to write more meaningful commit messages. Shinken has grown big now, so IMHO we should put some eye on development quality, too.

For the PyInstaller project we commited us to the rules described in <http://www.pyinstaller.org/wiki/Development/CommitMessages>. These rules are based on eg. the FreeBSD Committer's Guide. There is also a guide "How to write a good commit message".

I would really appreciate to see more meaningful commit messages in the future.


Yes, some are not so helpful, especially the one that is just a Fix with the github number. We should always put a real commit message, because when we are reading the logs for the Changelog, it's a nightmare to go in github every two minutes :)

But for the easters, I will not put real comments. Easters are for people that look deeper in the code, and so I'll not help them find it with real comments, because it will kill the fun of finding them :)