git-z 0.1.0

A Git extension to go beyond.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

version = "0.1"

# The available types of commits.
#
# This is a list of types (1 word) and their description, separated by one or
# more spaces.
types = [
    "feat      adds a new feature in the code",
    "sec       patches a security issue",
    "fix       patches a code bug",
    "perf      enhances the performance, without adding a new feature",
    "refactor  refactors the code",
    "test      adds, updates or removes tests only",
    "docs      updates the documentation only",
    "style     updates the style, like running clang-format or changing headers",
    "deps      adds, updates or removes external dependencies",
    "build     updates the build system or build scripts",
    "env       updates the development environment",
    "ide       updates the IDE configuration",
    "ci        updates the CI configuration",
    "revert    reverts a previous commit",
    "chore     updates something that is not covered by any other type",
    "wip       work in progress / to be rebased and squashed later",
    "debug     commit used for debugging purposes, not to be integrated",
]

# The list of valid scopes.
scopes = [
    "changelog",
    "config",
    "contributing",
    "git-z",
    "lib",
    "readme",
    "version",
]

# The list of valid ticket prefixes.
ticket_prefixes = ["PROJECT-", "OTHER-"]

# The commit message template, written with the Tera [1] templating engine.
# [1] https://tera.netlify.app/
template = """
{{ type }}{% if scope %}({{ scope }}){% endif %}{% if breaking_change %}!{% endif %}: {{ description }}

# Feel free to enter a longer description here.

Refs: {{ ticket }}

{% if breaking_change %}BREAKING CHANGE: {{ breaking_change }}{% endif %}
"""