add(convention helper): helper for tagged convention

andre-filho · andre-filho · commit db39415d7c11 · 2018-11-26T11:07:15.000-02:00
diff --git a/commit_helper/__main__.py b/commit_helper/__main__.py
@@ -5,6 +5,7 @@
 from .utils.text_utils import debug
 from .utils.file_handler import handle_file_based_commit
 from .utils.flag_commit_handler import convention_flag_handler
+# convention imports
 from .conventions.convention_help_handler import convention_help_handler
 
 
diff --git a/commit_helper/conventions/tagged.py b/commit_helper/conventions/tagged.py
@@ -9,10 +9,23 @@ def tagged_convention(tag, msg):
     Convention format:
 
     TAG: message
+    <BLANK>
+    <body>
+    <BLANK>
+    <footer>
+
     ---
     Tag usage:
 
-    ADD:
-
-
+    ADD     -> use for new files or methods
+    FEAT    -> for when adding a new feature
+    DEL     -> use for excluded files or methods
+    CHR     -> use for normal dev work and maintainance
+    MERGE   -> use for signal merges
+    DOCS    -> for documentation changes
+    FIX     -> use for solving bugs or failures in file
+    REF     -> use for when you rename a file
+    STYLE   -> use for fixing stylesheet errors
+    TEST    -> use for test files
+    CI      -> for that commit that aims for fix a build
     """
