Comments on: Making the most of your source control summaries http://jamesmckay.net/2009/03/making-the-most-of-your-source-control-summaries/ because there are few things that are less logical than business logic Mon, 19 Dec 2011 16:13:58 +0000 hourly 1 http://wordpress.org/?v=3.3 By: PhiLho http://jamesmckay.net/2009/03/making-the-most-of-your-source-control-summaries/comment-page-1/#comment-3866 PhiLho Wed, 18 Mar 2009 13:56:31 +0000 http://jamesmckay.net/2009/03/making-the-most-of-your-source-control-summaries/#comment-3866 Good advice. I have read a page on good practices of commit comments (can't find it back). It advised to make a short, to the point first sentence. To include bug number (if you have a tracker) in these comments. And to provide useful information as you show. The interest is that you can put there information you can't put in source code: if you remove a method, for example, you won't leave a comment explaining why the method is no longer there. You can also collect these information to generate a changelog. A common practice in open source development. One should not underestimate the usefulness of these comments. Good advice.
I have read a page on good practices of commit comments (can’t find it back).

It advised to make a short, to the point first sentence.
To include bug number (if you have a tracker) in these comments.
And to provide useful information as you show.

The interest is that you can put there information you can’t put in source code: if you remove a method, for example, you won’t leave a comment explaining why the method is no longer there.
You can also collect these information to generate a changelog. A common practice in open source development.

One should not underestimate the usefulness of these comments.

]]>