On Sun, 2018-12-16 at 15:43 -0800, Kevin Fenzi wrote:
Saw a nice article on commit messages:
https://juffalow.com/other/write-good-git-commit-message
The one big easy thing I liked from it was:
"A properly formed Git commit subject line should always be able to
complete the following sentence: if applied, this commit will <your
subject line here>"
I think this might be a good rule of thumb to apply to our commits, at
least in ansible repo. I'm as guilty as the next person on useless
commits, but I'm gonna try and do better. ;)
if your commit message is shorter than 500 words and doesn't explain:
1) the entire history of the problem
2) the detailed nature of the fix
3) every other possible approach you considered
4) brexit
you're just not trying hard enough.
...or...that might just be my philosophy. :P
but yes, isolating a change of interest down to a single commit and
then finding that commit message gives you absolutely no useful
information at all about the *reason* for the change is one of the most
annoying things I can think of.
--
Adam Williamson
Fedora QA Community Monkey
IRC: adamw | Twitter: AdamW_Fedora | XMPP: adamw AT happyassassin . net
http://www.happyassassin.net