feat(project): add commitizen support

zikeji · Sep 28, 2020 · b4df5c8 · b4df5c8
1 parent 2aa08f8
commit b4df5c8
Show file tree

Hide file tree

Showing 4 changed files with 1,800 additions and 34 deletions.
diff --git a/.gitconfig b/.gitconfig
@@ -0,0 +1,2 @@
+[commit]
+  template = ~/.gitmessage
diff --git a/.gitmessage b/.gitmessage
@@ -0,0 +1,33 @@
+#     <type>(<scope>): <subject>
+#     <BLANK LINE>
+#     <body>
+#     <BLANK LINE>
+#     <footer>
+# 
+# Please note that:
+#  - The HEADER is a single line of max. 50 characters that         
+#    contains a succinct description of the change. It contains a   
+#    type, an optional scope, and a subject
+#       + <type> describes the kind of change that this commit is   
+#                providing. Allowed types are:
+#             * feat (feature)
+#             * fix (bug fix)
+#             * docs (documentation)
+#             * style (formatting, missing semicolons, …)
+#             * refactor
+#             * test (when adding missing tests)
+#             * chore (maintain)
+#       + <scope> can be anything specifying the place of the commit    
+#                 change
+#       + <subject> is a very short description of the change, in   
+#                   the following format:
+#             * imperative, present tense: “change” not             
+#               “changed”/“changes”
+#             * no capitalised first letter
+#             * no dot (.) at the end
+#  - The BODY should include the motivation for the change and      
+#    contrast this with previous behavior and must be phrased in   
+#    imperative present tense 
+#  - The FOOTER should contain any information about Breaking       
+#    Changes and is also the place to reference GitHub issues that   
+#    this commit closes