[Bf-committers] Guidelines to format commit logs

Brecht Van Lommel brechtvanlommel at pandora.be
Sun Nov 17 09:49:51 CET 2013

On Sat, Nov 16, 2013 at 11:51 PM, GSR <gsr.b3d at infernal-iceberg.com> wrote:
> brechtvanlommel at pandora.be (2013-11-15 at 2039.00 +0100):
>> Sending a reminder for after the switch to git, we have guidelines for
>> how to format your commit logs to keep it all easy to scan quickly,
>> understand for users and turn into release notes.
>> The wiki page with guidelines is here:
>> http://wiki.blender.org/index.php/Dev:Doc/New_Committer_Info#Commit_Logs
> Will Blender follow the git standards of first short line summary
> followed, if needed, by a blank line and extra explanations, and
> limiting the number of columns in logs?

The short line summary is in the guidelines. Limiting the number of
columns I'm not sure about, we could add it but I would already be
very happy if people followed the basics.

> Luckly compared to SVN, this time some checks can be done via hooks,
> instead of having to pest everyone by email and then getting ignored
> anyway. Or by using pulls by someone after reviewing, instead of
> pushing by everyone without control.
> What is more, now with git there is no excuse for huge commits or
> commits that mix different things like improvements and fixes, or
> things from different topics. Changes can be organized logically, in
> small steps. But people must do that right to begin, or follow the
> pull approach so master is clean.

The plan with this new infrastructure is to have more code review to
catch bugs, bad commit logs, too big commits, etc.

How strict we are going to be about enforcing such rules I don't know
yet, needs discussion among the developers, personally I want us to be
quite strict.


More information about the Bf-committers mailing list