commit_helper/conventions/tagged.py

def tagged_convention(tag, msg):
    """
    Formats the convention following the tag convention.

    The tagged convention:
    <TAG>: <message>
    """
    tag = tag.upper()
    composed_message = "%s: %s\n" % (tag, msg)
    return composed_message


tagged_convention_help = \
    """
    The tagged convention:

    TAG: message
    <BLANK>
    <body>
    <BLANK>
    <footer>

    ---
    Tag usage:

    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
    """