19736
by Luiz Augusto von Dentz
gitlint: Add .gitlint configuration |
1 |
# All these sections are optional, edit this file as you like. |
2 |
# [general] |
|
3 |
# ignore=title-trailing-punctuation, T3 |
|
4 |
# verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this |
|
5 |
# verbosity = 2 |
|
6 |
# By default gitlint will ignore merge commits. Set to 'false' to disable. |
|
7 |
# ignore-merge-commits=true |
|
8 |
# Enable debug mode (prints more output). Disabled by default. |
|
9 |
# debug=true |
|
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 |
|
13 |
# extra-path=examples/ |
|
14 |
||
15 |
[title-max-length] |
|
16 |
line-length=72 |
|
17 |
||
18 |
# [title-must-not-contain-word] |
|
19 |
# Comma-separated list of words that should not occur in the title. Matching is case |
|
20 |
# insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING" |
|
21 |
# will not cause a violation, but "WIP: my title" will. |
|
22 |
# words=wip |
|
23 |
||
24 |
# [title-match-regex] |
|
25 |
# python like regex (https://docs.python.org/2/library/re.html) that the |
|
26 |
# commit-msg title must be matched to. |
|
27 |
# Note that the regex can contradict with other rules if not used correctly |
|
28 |
# (e.g. title-must-not-contain-word). |
|
29 |
# regex=^US[0-9]* |
|
30 |
||
31 |
# [B1] |
|
32 |
# B1 = body-max-line-length |
|
33 |
# line-length=120 |
|
34 |
||
35 |
[body-min-length] |
|
36 |
min-length=1 |
|
37 |
||
38 |
# [body-is-missing] |
|
39 |
# Whether to ignore this rule on merge commits (which typically only have a title) |
|
40 |
# default = True |
|
41 |
# ignore-merge-commits=false |
|
42 |
||
43 |
# [body-changed-file-mention] |
|
44 |
# List of files that need to be explicitly mentioned in the body when they are changed |
|
45 |
# This is useful for when developers often erroneously edit certain files or git submodules. |
|
46 |
# By specifying this rule, developers can only change the file when they explicitly reference |
|
47 |
# it in the commit message. |
|
48 |
# files=gitlint/rules.py,README.md |