To use:
- Save the template to
~/.gitmessage
- Run
git config --global commit.template ~/.gitmessage
# Title: Summary, One-sentence headline description of change | |
# Start upper case, don't end with a period | |
# 50 chars max. This line is 50 chars long ###### | |
# (Remember blank line between title and body.) | |
# | |
# Body: Explain *what* and *why* (not *how*). | |
# | |
# Add as many paragraphs as needed | |
# | |
# State the problem you're solving. This might be a description of | |
# a bug, or a quick overview of the new feature you're adding. | |
# | |
# Describe your changes. You can summarize what approach you | |
# took, what each part of the change is for, and why it works well. | |
# | |
# If applicable, explain any obvious alternative approaches you rejected. | |
# Add caveats of your approach | |
# | |
# Wrap at 72 chars. This line is 74 chars ############################# | |
# Add the ticket URL: | |
Addresses https://COMPANY.atlassian.net/browse/XX-XXX | |
# At the end: Include Co-authored-by for all contributors. | |
# Include at least one empty line before it. Format: | |
# | |
# Co-authored-by: name <[email protected]> |