[Scummvm-devel] Adopting a commit message convention

Ori Avtalion ori at avtalion.name
Thu Oct 1 16:14:36 CEST 2009


Hi,

If the project will one day move to a distributed VCS, maybe it should 
adopt a popular commit message convention.

Many of the VCS systems and related tools distinguish between a one-line 
summary of the commit, and a detailed description.

Tools such as gitk, gitweb and hgweb will only display the first line of 
a commit in the regular log view. This will cause commits in the 
(popular scummvm) form of

    - some fixes
    - some more fixes

to be truncated to "- some fixes".

A developer using git-svn or a similar tool can miss part of the commit 
message.

The standard git/hg/whatever commit message has a single line with a 
short description, followed by an empty line and a detailed description.

An example can be found here: http://www.tpope.net/node/106

What do you think?




More information about the Scummvm-devel mailing list