Purpose
I wrote this to quickly refer to the the points I found relevant in https://chris.beams.io/posts/git-commit/.
Point 1
While many repositories’ logs look like the former, there are exceptions. The Linux kernel and Git itself are great examples. Look at Spring Boot, or any repository managed by Tim Pope.
Point 2
The seven rules of a great Git commit message:
Separate subject from body with a blank line
Limit the subject line to 50 characters
Capitalize the subject line
Do not end the subject line with a period
Use the imperative mood in the subject line
Wrap the body at 72 characters
Use the body to explain what and why vs. how
Point 3
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
Point 4
This commit from Bitcoin Core is a great example of explaining what changed and why:
Point 5
Read Pro Git
Additional Links
Documentation on how to contribute to Linux kernel
Specific doc on formatting a patch
Content Cited
Content from https://chris.beams.io/posts/git-commit/
git image from https://git-scm.com/images/logos/downloads/Git-Logo-2Color.png found by Googling "git" images on 2017-10-14
Comments