Committing message ethics
The commit message is free form text. It can be whatever you think is useful. However, there are comment conventions used in the Git community.
How to do it...
- Use 72 characters or less on each line. Use blank lines to separate paragraphs.
- The first line should be 50 characters or less and summarize why this commit was made. It should be specific enough that someone reading just this line will understand what happened.
- Don't write
Fix bug
or evenFix bugzilla bug #1234
, writeRemove silly messages that appear each April 1
.
The following paragraphs describe details that will be important to someone following up on your work. Mention any global state variables your code uses, side effects, and so on. If there is a description of the problem you fixed, include the URL for the bug report or feature request.