[Bf-committers] comments/notes in commit logs AND source
Ken Hughes
khughes at pacific.edu
Mon Mar 27 20:37:33 CEST 2006
Martin Poirier wrote:
> Please, when you commit code in places where you are
> not the maintainer, at least add some technical change
> notes to the commit log (at best, go through the patch
> tracker, of course).
>
> It's harder to maintain code which I haven't done,
> just imagine what happens when people drop some in
> without warning and without docs.
I'll second that, plus add a suggestion for everybody (maintainer or
otherwise): add some comments to the code to describe what it does. It
really helps newcomers when they're trying to learn how blender does
things, not to mention reminds you what you had in mind when you coded it.
Ken
More information about the Bf-committers
mailing list