[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
don't use "fix xyz" in git commit messages
From: |
Graham Percival |
Subject: |
don't use "fix xyz" in git commit messages |
Date: |
Mon, 29 Aug 2011 12:39:22 +0100 |
User-agent: |
Mutt/1.5.20 (2009-06-14) |
For more visibility: saying "fix 123" only means something to
people who have memorized all 600+ open bugs.
- please give a short description of the actual code change, like
"foo grob now avoids collisions with baz (123)".
I think it's still useful to add the issue number, but that
should only come after an English summary of the change.
(and I suggest we use parentheses to indicate that the number
is an issue number)
- if your patch includes a syntax change, please add "(syntax)" to
the short git commit
We have about 20 patches coming in each week, with a backlog of
about 50 patches. Unless we start driving developers away, we
need to be able to scan+review lots of patches regularly, and
better commit messages will help a lot.
Cheers,
- Graham
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- don't use "fix xyz" in git commit messages,
Graham Percival <=