summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--git-commit-template25
1 files changed, 24 insertions, 1 deletions
diff --git a/git-commit-template b/git-commit-template
index 656b83e..5c29588 100644
--- a/git-commit-template
+++ b/git-commit-template
@@ -1,5 +1,28 @@
# If applied this commit will...
-Add/Fix/Drop/Change/Refactor/Document: whatever
+
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+
+# https://www.conventionalcommits.org/en/v1.0.0/
+# feat: new feature
+# fix: bug fix
+# fix(parse): a bug fix to the parser
+# feat!: this feature breaks something
+# build:
+# chore:
+# ci:
+# docs:
+# style:
+# refactor:
+# perf:
+# test:
+#
+# footers:
+# BREAKING-CHANGE: for anything that breaks semver major version
+# Closes: #id
# Why is it necessary? (Bug fix, feature, improvements?)