From 907195ae7af2a908282b01a000f75f618fd0a270 Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Thu, 16 Jan 2020 14:11:24 +0100 Subject: [PATCH] [IMP] base: add a commit message template with the guidelines --- commit_template.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 commit_template.txt diff --git a/commit_template.txt b/commit_template.txt new file mode 100644 index 000000000..bfdf50ef4 --- /dev/null +++ b/commit_template.txt @@ -0,0 +1,19 @@ +[TAG] application/module: describe your changes in a short sentence + +# If you feel that it might help a future reader to understand your commit +# motivations, take some time to explain WHY you made these changes in a few +# sentences. The WHAT is usually easily understood by reading the diff. +# +# Short description tip: structure your commit message as if it was completing +# this sentence: "If merged, this commit will ...". For instance, the following +# commit message is correct: "[IMP] sales: compress images to save space". +# +# Tag meanings: +# +# [ADD] = New content +# [IMP] = Improvement +# [FIX] = Content or RST fix +# [REM] = Removal +# [REF] = Refactoring (restructuring) +# [MOV] = Move/rename +# \ No newline at end of file