Sep 24, 2008 / coding
Write Better SVN (or GIT) Commit Messages

I was browsing various open source projects on GitHub last night and it was interesting to see the variation in submit comments.

The comments that seemed the most useful were ones that described the end result rather than how it was achieved. For example

updated readme   

...would become...

The README file is now up to date.    

It looks better in context, see the Iron Nails .NET project on GitHub.

It's a suble difference, but important.

I also think repositories look far nicer when commit comments start with upper case. Yeah yeah that's anal I know :)

You may also like...