[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [ecf-dev] Git commit messages

On 06/22/2011 10:48 AM, Alex Blewitt wrote:

> Basically, the convention is to have a single short line of text (less
> than 50 chars) which summarises the change, followed by a blank line,
> and then more text separated by blank lines (if there's more than one
> paragraph). The final section is for Key: Value pairs, which can include
> Signed-off-by and Change-Id as well as custom values, like Bug: 12345.
> 
> Many of the changes in the current ECF log are one-liners, and often
> just reference a bugzilla item. This doesn't help someone who has cloned
> the repository knowing why the changes were made. Consider these two
> changes below (both for the same fix, bug 349078).
> 
> Being able to do 'git log --oneline' and see descriptive changes is a
> lot more useful than being able to see a list of referenced bugs, as
> well as giving someone who has cloned (and may not be connected to the
> internet) the repository.

+1, especially because log messages are available offline and one gets a
better idea of what the changes is about on the Jenkins changes page.

If we all agree on it, we might want add a post-receive-hook that checks
the commit message for proper formatting.

Markus