Hi all,

Just to make sure we understand each other...

The text that goes with a commit is meant to make review easier. That
is, when tracking a particular bug that was "just introduced", it is
probably around 20 times faster to try to locate the file that is the
origin of the problem, then to see which commits were recently made on
that file, just by looking at the title of the commit.

As such, a commit text like "Preparing merge with STABLE" or "Exercises
categories" is rather useless and would force the reviewer to open each
and every one of the commit detail page and analyse the code in-depth to
try and figure out what was changed.

In general, it is always possible to find a clear explanation of what
one has done. Like for example: "Reformat exercise wrapper to include
white spaces before merge", or "Fixed random capability of exercises
categories".

I'm pretty sure a number of you will recognize themselves in these
descriptions. Please consider that we are not enough people to be
wasting the time of reviewers just for momentaneous laziness. It is
important to be strict and a proper patch should not be considered
complete until you have found the proper wording to explain the commit.

Also, I generally use a special keyword to indicate that the commit is
just a code style change (and as such it has no chance of introducing a
bug): I prefix my commit with "Minor - ".

Finally, Redmine has a pretty neat feature which allows you to
automatically bind a commit to a corresponding task in Redmine.
This is done by setting up a local copy of the repository on the Redmine
server and using the " refs #3456 " suffix in your commits. This allows
for even faster code review, because you can search for a bug in Redmine
and then get the reference to the corresponding commit immediately.

I should be migrating Redmine to our new server next week, so setting up
these local repositories should be easy and practical.

Nice to see a few people getting back to work on 2.*!

Yannick


_______________________________________________
Dev mailing list
Dev@lists.chamilo.org
http://lists.chamilo.org/listinfo/dev

Reply via email to