git-z.toml

version = "0.2"

# The available types of commits and their description.
#
# Types are shown in the dialog in the order they appear in this configuration.
[types]
feat = "adds a new feature"
sec = "patches a security issue"
fix = "patches a bug"
refactor = "refactors the code"
docs = "updates the documentation only"
style = "updates the style, like running clang-format or changing headers"
deps = "adds, updates or removes external dependencies"
ide = "updates the IDE configuration"
chore = "updates something that is not covered by any other type"
wip = "work in progress / to be rebased and squashed later"

# The list of valid scopes.
[scopes]
# What kind of scope to accept.
#
# Can be one of: "any", "list". If it is "list", a `list` key containing a list
# of valid scopes is required.
accept = "any"

# Templates written with the Tera [1] templating engine.
#
# Each template is documented below, with its list of available variables.
# Variables marked as optional can be `None`, hence should be checked for
# presence in the template.
#
# [1] https://tera.netlify.app/
[templates]
# The commit template.
#
# Available variables:
#
#   - type: the type of commit
#   - scope (optional): the scope of the commit
#   - description: the short description
#   - breaking_change (optional): the description of the breaking change
#   - ticket (optional): the ticket reference
commit = """
{{ type }}{% if scope %}({{ scope }}){% endif %}{% if breaking_change %}!{% endif %}: {{ description }}

# Feel free to enter a longer description here.
"""