Skip to content

Instantly share code, notes, and snippets.

@nesterchung

nesterchung/gist:4d9e99fdc8a3fb70698b6665791a4e20

Forked from matthewhudson/good-commit.md
Created August 21, 2018 02:38
Show Gist options
  • Save nesterchung/4d9e99fdc8a3fb70698b6665791a4e20 to your computer and use it in GitHub Desktop.
Save nesterchung/4d9e99fdc8a3fb70698b6665791a4e20 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
gistfile1.txt
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 <[email protected]>
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