Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: adding note on prepare-commit-msg git hook

...

Code Block
Header line: Explain the commit in one line

Body of commit message is a few lines of text, explaining things in more detail,

possibly giving some background about the issue being fixed, etc etc. Use bullets if possible:
 - Line 1
 - Line 2 etc.
 * Start works too, instead of -

The body of the commit message can be several paragraphs, and please do proper word-wrap

and keep columns shorter than about 80 characters or so. That way "git log" will show things

nicely even when it's indented.

Reviewed-by: Person or link to review on review.apache.org
Reported-by: whoever-reported-it, if applicable
Signed-off-by: Your Name <youremail@yourhost.com>

Note that there exists a git hook to prepare a commit form for you, located at tools/git/prepare-commit-msg. One simply needs to link to it in order to use it:

Code Block

ln -s ../../tools/git/prepare-commit-msg .git/hooks/prepare-commit-msg

Please use a logical prefix, which should be:

...