blob: 7e0e5d3b5e6360735bf92f03002cf28ee1062ebf [file] [log] [blame]
Anas Nashifa35378e2017-04-22 11:59:30 -04001# All these sections are optional, edit this file as you like.
2[general]
Anas Nashif9c6a1aa2018-02-07 13:00:59 -06003ignore=title-trailing-punctuation, T3, title-max-length, T1, body-hard-tab, B3, B1
Anas Nashifa35378e2017-04-22 11:59:30 -04004# verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
Kumar Galae9ec91b2017-07-13 12:38:29 -05005verbosity = 3
Anas Nashifa35378e2017-04-22 11:59:30 -04006# By default gitlint will ignore merge commits. Set to 'false' to disable.
7ignore-merge-commits=true
8# Enable debug mode (prints more output). Disabled by default
9debug = false
10
11# Set the extra-path where gitlint will search for user defined rules
12# See http://jorisroovers.github.io/gitlint/user_defined_rules for details
13extra-path=scripts/gitlint
14
Anas Nashif87766a22017-08-08 08:36:01 -040015[title-max-length-no-revert]
Anas Nashif3085ce02019-05-29 08:43:36 -040016line-length=75
Anas Nashifa35378e2017-04-22 11:59:30 -040017
Anas Nashif2dd5cef2018-01-10 19:12:00 -050018[body-min-line-count]
19min-line-count=1
20
Anas Nashifa35378e2017-04-22 11:59:30 -040021[body-max-line-count]
22max-line-count=200
23
Anas Nashif3c27c462017-05-05 19:37:52 -040024[title-starts-with-subsystem]
Anas Nashif8d84f922018-11-21 23:08:25 -050025regex = ^(?!subsys:)(([^:]+):)(\s([^:]+):)*\s(.+)$
Anas Nashif3c27c462017-05-05 19:37:52 -040026
Anas Nashifa35378e2017-04-22 11:59:30 -040027[title-must-not-contain-word]
28# Comma-separated list of words that should not occur in the title. Matching is case
29# insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"
30# will not cause a violation, but "WIP: my title" will.
David B. Kinder2541f872017-09-15 11:08:54 -070031words=wip
Anas Nashifa35378e2017-04-22 11:59:30 -040032
33[title-match-regex]
34# python like regex (https://docs.python.org/2/library/re.html) that the
35# commit-msg title must be matched to.
36# Note that the regex can contradict with other rules if not used correctly
37# (e.g. title-must-not-contain-word).
38#regex=^US[0-9]*
39
Anas Nashifb5200752017-06-06 08:50:11 -040040[max-line-length-with-exceptions]
Anas Nashifa35378e2017-04-22 11:59:30 -040041# B1 = body-max-line-length
42line-length=72
43
44[body-min-length]
45min-length=3
46
47[body-is-missing]
48# Whether to ignore this rule on merge commits (which typically only have a title)
49# default = True
50ignore-merge-commits=false
51
52[body-changed-file-mention]
53# List of files that need to be explicitly mentioned in the body when they are changed
54# This is useful for when developers often erroneously edit certain files or git submodules.
55# By specifying this rule, developers can only change the file when they explicitly reference
56# it in the commit message.
57#files=gitlint/rules.py,README.md