Skip to content

Instantly share code, notes, and snippets.

@tahniat-ashraf
Forked from adeekshith/.git-commit-template.txt
Last active August 20, 2019 11:28
Show Gist options
  • Save tahniat-ashraf/1a7f37c1588e3a8446c7d8a8f6f68b8c to your computer and use it in GitHub Desktop.
Save tahniat-ashraf/1a7f37c1588e3a8446c7d8a8f6f68b8c to your computer and use it in GitHub Desktop.
This commit message template helps you write great commit messages and enforce it across teams.
# <type>: (If applied, this commit will...) <subject> (Max 50 char)
# |<---- Using a Maximum Of 50 Characters ---->|
# Example: MRV-13: Introduce the widget to handle image creation
# (Optional) Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# (Optional) Provide links or keys to any relevant tickets, articles or other resources
# Example: closes MRV-22
# --- COMMIT END ---
# Type : Task id on JIRA/Atlassian. e.g MRV-13
# Note : Type only applicable if the commit is associated with a task id. If not, type can be skipped
# --------------------
# Remember to
#1. Separate subject from body with a blank line
#2. Limit the subject line to 50 characters
#3. Capitalize the subject line
#4. Do not end the subject line with a period
#5. Use the imperative mood in the subject line
#6. Wrap the body at 72 characters
#7. Use the body to explain what and why you have done something. In most cases, you can leave out details about how a change has been made
# --------------------
@tahniat-ashraf
Copy link
Author

Add following to your ~/.gitconfig:

[commit]
  template = /YOUR_DIRECTORY_PATH/.git-commit-template.txt

Screen-Shot-2019-08-11-at-2-45-31-AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment