[bind10-dev] commit messages

[Jelte Jansen]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


As we're getting used to git, there are some things we find that could improve
the process. One issue we discussed yesterday was that it can be a bit hard to
find the start of a specific set of changes.

So i'd like to propose that if we do a commit in a branch, we start the commit
message brief description with [<branchname>], so that when browsing through the
repository branch commits, we can see what was the first commit of a branch.

Taking current gitk output for a random branch, currently it shows:

o some trivial style issues
o cleaned up a few debug dlogs, removed an extraneous ; and added a comment.
o put root server ip list into recursive query object
o First task of trac483

Now this example does happen to show where the first commit was (but the actual
message was less than informative about anything else :p), but most of the
commits don't, and sometimes one might not even realize a commit is the first in
a branch anymore.

Anyhow, if we would diligently adhere to this proposal, it would look like:

o [trac483] some trivial style issues
o [trac483] cleaned up a few debug dlogs, removed an extraneous ; and added a
comment.
o [trac483] put root server ip list into recursive query object
o [trac483] First task of trac483

Which I suspect would make it a lot easier to find all the changes for a branch
when doing a review (or more specific; the parent of the first commit, to
compare against HEAD). It might also have the nice side-effect that we can look
back on trac later to see for what purpose a specific change was made :)

Jelte
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk0/N10ACgkQ4nZCKsdOncWEeACguh/+ZTEOmZLhQ00fgcxFxxbi
yEEAnjJJLjL5p8/YluYn7VJPQNOvnNVZ
=jXLV
-----END PGP SIGNATURE-----