diff options
| -rw-r--r-- | _gitconfig | 2 | ||||
| -rw-r--r-- | _gitmessage | 35 |
2 files changed, 37 insertions, 0 deletions
@@ -26,6 +26,8 @@ [commit] # Sign every commit #gpgSign = true + # Use a message template + template = ~/.gitmessage [tag] # Sign every tag diff --git a/_gitmessage b/_gitmessage new file mode 100644 index 0000000..2e8bae7 --- /dev/null +++ b/_gitmessage @@ -0,0 +1,35 @@ + +# |<---- Using a Maximum Of 50 Characters ---->| +# <type>: (If applied, this commit will...) <subject> (Max 50 char) +# +# 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 tickets, articles or other resources +# e.g., Github issue #23 + +# Signed-off-by: Aaron LI <aly@aaronly.me> + +# --- 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 or 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 +# -------------------- +# Configuration: +# git config --global commit.template ~/.gitmessage +# +# For more information about this template, check out +# https://gist.github.com/adeekshith/cd4c95a064977cdc6c50 |