• Zach Pfeffer

Key points from Chris Beams git-commit


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:

  1. Separate subject from body with a blank line

  2. Limit the subject line to 50 characters

  3. Capitalize the subject line

  4. Do not end the subject line with a period

  5. Use the imperative mood in the subject line

  6. Wrap the body at 72 characters

  7. 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

Content Cited

  1. Content from https://chris.beams.io/posts/git-commit/

  2. git image from https://git-scm.com/images/logos/downloads/Git-Logo-2Color.png found by Googling "git" images on 2017-10-14

Our Recent Posts

Tags

SEARCH THIS SITE

©2020 by Zach Pfeffer