RomuloOliveira / commit-messages-guide

A guide to understand the importance of commit messages and how to write them well

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add some details about setting up a git commit template

menixator opened this issue · comments

I think it will be really helpful if some details about adding a git commit template was added. This way when they do git commit the editor will pop up with the template inside.

For instance:

  • ~/.gitcommit.template

# Summarize changes in around 50 characters or less
#
# Write the messages in imperative form:
# If applied, this commit will <commit message>
#
# Example:
#  If applied, this commit will use InventoryBackendPool to retrieve inventory backend
# 
# More detailed explanatory text, if necessary. Wrap it to about 72
# characters or so. In some contexts, the first line is treated as the
# subject of the commit and the rest of the text as the body. The
# blank line separating the summary from the body is critical (unless
# you omit the body entirely); various tools like `log`, `shortlog`
# and `rebase` can get confused if you run the two together.
# 
# Explain the problem that this commit is solving. Focus on why you
# are making this change as opposed to how (the code explains that).
# Are there side effects or other unintuitive consequences of this
# change? Here's the place to explain them.
# 
# Further paragraphs come after blank lines.
# 
#  - Bullet points are okay, too
# 
#  - Typically a hyphen or asterisk is used for the bullet, preceded
#    by a single space, with blank lines in between, but conventions
#    vary here
# 
# If you use an issue tracker, put references to them at the bottom,
# like this:
# 
# Resolves: #123
# See also: #456, #789
  • Setting it up
git config --global commit.template ~/.gitcommit.template

Now, running git commit will always bring up that template loaded in the editor.