note about writing git log messages
Ondrej Certik
here is how to write git log messages:
you don't have to be that pedantic like in that post, but please try
to follow the following:
* first line should be short explanation what the patch does
* second line is empty
* then explain the rest, in paragraphs
More notes about the first line: people usually don't put a dot at the
end, just like a subject in the email. Also keep it less than 50 chars
(if possible), because if it's longer, it's hard to read in things
like "git log" in 80 characters terminal. If you use vim with "git
commit", it automatically shows things in red if you put anything on
the second line, and things in black if you exceed the 50 chars limit,
so it naturally guides you.
Otherwise use your intuition, and if its impossible to fit the log
message <50 char, I think it's not a big deal either, but definitely
keep it < 80 char and make the second line blank.
Thanks,
Ondrej
Ondrej Certik
> Hi,
>
> here is how to write git log messages:
>
> http://www.tpope.net/node/106
Also, the above blog requires more things, like keeping things in
present tense etc. I don't think this is important, I actually think
it's better if you write the log in your own style, just like an
email.
Just remember the purpose of the log message: to make it easy for
other people to follow your line of thought when you created the
patch, so that they understand what the *purpose* is (and why you did
what you did), so I think it's necessary subjective.
Technical (non subjective) things that help to understand the code
should go to the comments in the actual code.
Ondrej