Created
January 14, 2021 20:14
-
-
Save tarecord/6e8cb13136f8ebc263c4dcb07b2a30da to your computer and use it in GitHub Desktop.
A template to help you write better commits
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ######## Subject Line (50 characters) ############ | |
| # - Use the imperative mood (imagine the words "This will") | |
| # - Capitalize the first letter | |
| # - Limit to 50 characters | |
| # - Do not end the subject line with a period | |
| ######## The Body (72 characters per line) ############################# | |
| # - Add line breaks so each line is a maximum of 72 characters | |
| # - Explain the thinking behind the commit | |
| # - Do not use Markdown | |
| ######## Issue or Ticket Reference ######## | |
| # - The last line should reference the issue or ticket |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this template to your git config:
~/.git/.commit_template) and copy over the templategit config --global commit.template /path/to/.commit_template