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