| 1 |
# Edit this file as you like. |
| 2 |
# |
| 3 |
# All these sections are optional. Each section with the exception of [general] |
| 4 |
# represents one rule and each key in it is an option for that specific rule. |
| 5 |
# |
| 6 |
# Rules and sections can be referenced by their full name or by id. For example |
| 7 |
# section "[body-max-line-length]" could be written as "[B1]". Full section |
| 8 |
# names are used in here for clarity. |
| 9 |
# |
| 10 |
[general] |
| 11 |
# Ignore certain rules, this example uses both full name and id |
| 12 |
# B6 body-is-missing |
| 13 |
# T5 title-must-not-contain-word |
| 14 |
ignore=B6, T5 |
| 15 |
|
| 16 |
# verbosity should be a value between 1 and 3, the commandline -v flags take |
| 17 |
# precedence over this |
| 18 |
# verbosity = 2 |
| 19 |
|
| 20 |
# By default gitlint will ignore merge, revert, fixup and squash commits. |
| 21 |
# ignore-merge-commits=true |
| 22 |
# ignore-revert-commits=true |
| 23 |
# ignore-fixup-commits=true |
| 24 |
# ignore-squash-commits=true |
| 25 |
|
| 26 |
# Ignore any data send to gitlint via stdin |
| 27 |
# ignore-stdin=true |
| 28 |
|
| 29 |
# Fetch additional meta-data from the local repository when manually passing a |
| 30 |
# commit message to gitlint via stdin or --commit-msg. Disabled by default. |
| 31 |
# staged=true |
| 32 |
|
| 33 |
# Enable debug mode (prints more output). Disabled by default. |
| 34 |
# debug=true |
| 35 |
|
| 36 |
# Enable community contributed rules |
| 37 |
# See http://jorisroovers.github.io/gitlint/contrib_rules for details |
| 38 |
# contrib=contrib-title-conventional-commits,CC1 |
| 39 |
|
| 40 |
# Set the extra-path where gitlint will search for user defined rules |
| 41 |
# See http://jorisroovers.github.io/gitlint/user_defined_rules for details |
| 42 |
extra-path=script/gitlint/custom_gitlint_rules.py |
| 43 |
|
| 44 |
[title-is-capitalized] |
| 45 |
|
| 46 |
[title-is-imperative] |
| 47 |
|
| 48 |
# This is an example of how to configure the "title-max-length" rule and |
| 49 |
# set the line-length it enforces to 80 |
| 50 |
[title-max-length] |
| 51 |
line-length=50 |
| 52 |
|
| 53 |
# [title-must-not-contain-word] |
| 54 |
# Comma-separated list of words that should not occur in the title. Matching is |
| 55 |
# case insensitive. It's fine if the keyword occurs as part of a larger word (so |
| 56 |
# "WIPING" will not cause a violation, but "WIP: my title" will. |
| 57 |
# words=wip |
| 58 |
|
| 59 |
[title-match-regex] |
| 60 |
# python like regex (https://docs.python.org/2/library/re.html) that the |
| 61 |
# commit-msg title must be matched to. |
| 62 |
# Note that the regex can contradict with other rules if not used correctly |
| 63 |
# (e.g. title-must-not-contain-word). |
| 64 |
# regex=^[A-Z].+ |
| 65 |
|
| 66 |
[body-max-line-length] |
| 67 |
line-length=72 |
| 68 |
|
| 69 |
[body-min-length] |
| 70 |
min-length=0 |
| 71 |
|
| 72 |
# [body-is-missing] |
| 73 |
# Whether to ignore this rule on merge commits (which typically only have a |
| 74 |
# title) |
| 75 |
# default = True |
| 76 |
# ignore-merge-commits=false |
| 77 |
|
| 78 |
# [body-changed-file-mention] |
| 79 |
# List of files that need to be explicitly mentioned in the body when they are |
| 80 |
# changed This is useful for when developers often erroneously edit certain |
| 81 |
# files or git submodules. By specifying this rule, developers can only change |
| 82 |
# the file when they explicitly reference it in the commit message. |
| 83 |
# files=gitlint/rules.py,README.md |
| 84 |
|
| 85 |
# [author-valid-email] |
| 86 |
# python like regex (https://docs.python.org/2/library/re.html) that the commit |
| 87 |
# author email address should be matched to For example, use the following regex |
| 88 |
# if you only want to allow email addresses from foo.com |
| 89 |
# regex=[^@][email protected] |
| 90 |
|
| 91 |
# [ignore-by-title] |
| 92 |
# Ignore certain rules for commits of which the title matches a regex |
| 93 |
# E.g. Match commit titles that start with "Release" |
| 94 |
# regex=^Release(.*) |
| 95 |
|
| 96 |
# Ignore certain rules, you can reference them by their id or by their full name |
| 97 |
# Use 'all' to ignore all rules |
| 98 |
# ignore=T1,body-min-length |
| 99 |
|
| 100 |
# [ignore-by-body] |
| 101 |
# Ignore certain rules for commits of which the body has a line that matches a |
| 102 |
# regex E.g. Match bodies that have a line that that contain "release" |
| 103 |
# regex=(.*)release(.*) |
| 104 |
# |
| 105 |
# Ignore certain rules, you can reference them by their id or by their full name |
| 106 |
# Use 'all' to ignore all rules |
| 107 |
# ignore=T1,body-min-length |
| 108 |
|
| 109 |
# This is a contrib rule - a community contributed rule. These are disabled by |
| 110 |
# default. You need to explicitly enable them one-by-one by adding them to the |
| 111 |
# "contrib" option under [general] section above. |
| 112 |
|
| 113 |
# [contrib-title-conventional-commits] |
| 114 |
# Specify allowed commit types. For details see: |
| 115 |
# https://www.conventionalcommits.org/ |
| 116 |
# types = bugfix,user-story,epic |