Skip to content

Instantly share code, notes, and snippets.

@stramargio
Created January 20, 2021 09:58
Show Gist options
  • Save stramargio/b1f6b753e3b6264cbd40c35487fee962 to your computer and use it in GitHub Desktop.
Save stramargio/b1f6b753e3b6264cbd40c35487fee962 to your computer and use it in GitHub Desktop.
Good commit message

A good commit message looks like this:

Header line: explaining 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.

The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
74 characters or so. That way "git log" will show things
nicely even when it's indented.

Reported-by: whoever-reported-it
Signed-off-by: Your Name <youremail@yourhost.com>

where that header line really should be meaningful, and really should be just one line. That header line is what is shown by tools like gitk and shortlog, and should summarize the change in one readable line of text, independently of the longer explanation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment