1# All these sections are optional, edit this file as you like.
2# Zephyr-specific defaults are located in scripts/gitlint/zephyr_commit_rules.py
3[general]
4ignore=title-trailing-punctuation, T3, title-max-length, T1, body-hard-tab, B3, B1
5# verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
6verbosity = 3
7# By default gitlint will ignore merge commits. Set to 'false' to disable.
8ignore-merge-commits=false
9ignore-revert-commits=false
10ignore-fixup-commits=false
11ignore-squash-commits=false
12# Enable debug mode (prints more output). Disabled by default
13debug = false
14
15# Set the extra-path where gitlint will search for user defined rules
16# See http://jorisroovers.github.io/gitlint/user_defined_rules for details
17extra-path=scripts/gitlint
18
19[title-max-length-no-revert]
20# line-length=75
21
22[body-min-line-count]
23# min-line-count=1
24
25[body-max-line-count]
26# max-line-count=200
27
28[title-starts-with-subsystem]
29regex = ^(?!subsys:)(?!treewide:)(([^:]+):)(\s([^:]+):)*\s(.+)$
30
31[title-must-not-contain-word]
32# Comma-separated list of words that should not occur in the title. Matching is case
33# insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"
34# will not cause a violation, but "WIP: my title" will.
35words=wip
36
37[title-match-regex]
38# python like regex (https://docs.python.org/2/library/re.html) that the
39# commit-msg title must be matched to.
40# Note that the regex can contradict with other rules if not used correctly
41# (e.g. title-must-not-contain-word).
42#regex=^US[0-9]*
43
44[max-line-length-with-exceptions]
45# B1 = body-max-line-length
46# line-length=75
47
48[body-min-length]
49min-length=3
50
51[body-is-missing]
52# Whether to ignore this rule on merge commits (which typically only have a title)
53# default = True
54ignore-merge-commits=false
55
56[body-changed-file-mention]
57# List of files that need to be explicitly mentioned in the body when they are changed
58# This is useful for when developers often erroneously edit certain files or git submodules.
59# By specifying this rule, developers can only change the file when they explicitly reference
60# it in the commit message.
61#files=gitlint/rules.py,README.md
62