blob: cadaca88f2890bc34a3e4f8b3890f2f60cb168cb [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 Nashif87766a22017-08-08 08:36:01 -04003ignore=title-trailing-punctuation, T3, title-max-length, T1
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]
16line-length=72
Anas Nashifa35378e2017-04-22 11:59:30 -040017
18[body-max-line-count]
19max-line-count=200
20
Anas Nashif3c27c462017-05-05 19:37:52 -040021[title-starts-with-subsystem]
22regex = ^(([^:]+):)(\s([^:]+):)*\s(.+)$
23
Anas Nashifa35378e2017-04-22 11:59:30 -040024[title-must-not-contain-word]
25# Comma-separated list of words that should not occur in the title. Matching is case
26# insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"
27# will not cause a violation, but "WIP: my title" will.
David B. Kinder2541f872017-09-15 11:08:54 -070028words=wip
Anas Nashifa35378e2017-04-22 11:59:30 -040029
30[title-match-regex]
31# python like regex (https://docs.python.org/2/library/re.html) that the
32# commit-msg title must be matched to.
33# Note that the regex can contradict with other rules if not used correctly
34# (e.g. title-must-not-contain-word).
35#regex=^US[0-9]*
36
Anas Nashifb5200752017-06-06 08:50:11 -040037[max-line-length-with-exceptions]
Anas Nashifa35378e2017-04-22 11:59:30 -040038# B1 = body-max-line-length
39line-length=72
40
41[body-min-length]
42min-length=3
43
44[body-is-missing]
45# Whether to ignore this rule on merge commits (which typically only have a title)
46# default = True
47ignore-merge-commits=false
48
49[body-changed-file-mention]
50# List of files that need to be explicitly mentioned in the body when they are changed
51# This is useful for when developers often erroneously edit certain files or git submodules.
52# By specifying this rule, developers can only change the file when they explicitly reference
53# it in the commit message.
54#files=gitlint/rules.py,README.md