aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/git/commit-msg-template
diff options
context:
space:
mode:
authoryexin <yexin13@huawei.com>2018-07-20 16:48:42 +0800
committeryalei wang <wylandrea@gmail.com>2018-07-26 08:17:55 +0000
commit24326186db0be2afb04aebf3b1277495eaaec150 (patch)
tree4bc54362e52ebc06b911d21ed287d7e533f63d32 /scripts/git/commit-msg-template
parent739fa21ba9d85582a2a996ad02d885acc4d4efe1 (diff)
Feat: add commit message template and hook
Use cmake to install the template and hook. Change-Id: Ie86ad2e1a4d1fe1999941445be969618b192eb32 Signed-off-by: yexin <yexin13@huawei.com>
Diffstat (limited to 'scripts/git/commit-msg-template')
-rw-r--r--scripts/git/commit-msg-template28
1 files changed, 28 insertions, 0 deletions
diff --git a/scripts/git/commit-msg-template b/scripts/git/commit-msg-template
new file mode 100644
index 0000000..6d72af1
--- /dev/null
+++ b/scripts/git/commit-msg-template
@@ -0,0 +1,28 @@
+# <type>: (if applied, this commit will...) <subject> (Max 50 chars)
+# |<---- 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 tickets, articles or other resources
+# 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 or refactoring tests; no production code change)
+# Chore (updating grunt tasks etc; no production code change)
+# --------------------
+# Remember to
+# Choose one of types above in 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
+# --------------------