Forked from adeekshith/.git-commit-template.txt
Last active
November 1, 2017 23:50
-
-
Save aelkz/706f633d9974fe6c98b53bc90502b565 to your computer and use it in GitHub Desktop.
This commit message template that helps you write great commit messages and enforce it across your team.
This file contains hidden or 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
| # <type>: (If applied, this commit will...) <subject> (Max 50 char) | |
| # |<------------- Using a Maximum Of 50 Characters ------------>| | |
| # Explain why this change is being made | |
| # |<--- Try To Limit Each Line to a Maximum Of 72 Characters ---->| | |
| # Provide links or keys to any relevant | |
| # [jira | tickets | articles | other resources] | |
| # Valid Example: Github issue #23 | |
| # --- COMMIT END --- | |
| # TYPE CAN BE: | |
| # | |
| # feat (new feature) | |
| # fix (bug fix) | |
| # refactor (refactoring production code) | |
| # style (formatting, missing semi colons, etc; no code change) | |
| # docs (changes to documentation) | |
| # test (adding/refactoring tests; no production code change) | |
| # chore (updating grunt tasks etc; no production code change) | |
| # -------------------- | |
| # REMEMBER TO: | |
| # Capitalize the subject line | |
| # Use the imperative mood in the subject line | |
| # Do not end the subject line with a period | |
| # Separate subject from body with a blank line | |
| # Use the body to explain what and why vs. how | |
| # Can use multiple lines with "-" for bullet points in body | |
| # -------------------- | |
| # For more information about this template, check out | |
| # https://gist.github.com/aelkz/706f633d9974fe6c98b53bc90502b565 |
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
To apply the template,
Save the above file to your local machine and use
git config --global commit.template <.git-commit-template.txt file path>For example, if you saved it to your home folder, try:
git config --global commit.template ~/.git-commit-template.txtReferences:
A useful template for commit messages
How to Write a Git Commit Message
Example for a Good Commit Message