forked from alrra/dotfiles
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgit_commit_message_template
40 lines (36 loc) · 1.9 KB
/
git_commit_message_template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# <type>(<scope?>): <ticket?> <subject> (Max 72 char)
# |<---------------- Using a Maximum Of 72 Characters ---------------->|
# <body?>
# Explain why this change is being made
# |<----- Try To Limit Each Line to a Maximum Of 72 Characters ----->|
# <footer?>
# - Provide any breaking changes
# Example: BREAKING CHANGE: <breaking change description>
# - Provide links or keys to any relevant tickets, articles or other resources
# Example: Closes #23
# --- COMMIT END ---
# Type can be
# feat (A new feature)
# fix (A bug fix)
# docs (Documentation only changes)
# style (Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc))
# refactor (A code change that neither fixes a bug nor adds a feature)
# perf (A code change that improves performance)
# test (Adding missing tests or correcting existing tests)
# build (Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm))
# ci (Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs))
# chore (Other changes that don't modify src or test files)
# revert (Reverts a previous commit)
# --------------------
# Remember to
# Lowercase the type, scope, subject fields (i.e. header line)
# Use the present 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/adeekshith/cd4c95a064977cdc6c50
# https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
# https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional