about summary refs log tree commit diff
path: root/home/git/commit.template
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2022-05-18 20:21:34 -0700
committerFranck Cuny <franck@fcuny.net>2022-05-18 20:21:34 -0700
commit579c203d12e6e095ec59e655d3d58747f450838b (patch)
tree33f7bb274ffba3e3a0a2dbde2c88d29e7087bed3 /home/git/commit.template
parentnix: bump dependencies (diff)
downloadworld-579c203d12e6e095ec59e655d3d58747f450838b.tar.gz
feat(git): add a template for commit messages
In order to write good commit message, having a reminder of how to write
them is useful. This template provides some guidance to categorize the
change and how to phrase the description.
Diffstat (limited to 'home/git/commit.template')
-rw-r--r--home/git/commit.template22
1 files changed, 22 insertions, 0 deletions
diff --git a/home/git/commit.template b/home/git/commit.template
new file mode 100644
index 0000000..01ab956
--- /dev/null
+++ b/home/git/commit.template
@@ -0,0 +1,22 @@
+# (If applied, this commit will...) <type>: <subject>
+
+# Explain why this change is being made
+
+# --- COMMIT END ---
+# Remember to
+#    Use the imperative mood, present tense: `change' not `changed' nor `changes'
+#    Do not end the subject line with a period
+#    Use the body to explain what and why vs. how
+#    Can use multiple lines with "-" for bullet points in body
+
+# Suggested types:
+# build: Changes that affect the build system or external dependencies
+# ci:    Changes to CI configuration files and scripts
+# docs:  Documentation only changes
+# feat:  A new feature
+# fix:   A bug fix
+# perf:  A code change that improves performance
+# ref:   A code change that neither fixes a bug nor adds a feature (refactor)
+# style: Changes that do not affect the meaning of the code
+# tests: Adding missing tests or correcting existing tests
+# meta:  Some meta information in the repo changes