diff --git a/docs/configuration.md b/docs/configuration.md index 866808ec..9c9197c7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -17,51 +17,63 @@ The block below shows a sample ```.gitlint``` file. Details about rule config op ```ini # All these sections are optional, edit this file as you like. -[general] -ignore=title-trailing-punctuation, T3 +# [general] +# Ignore certain rules, you can reference them by their id or by their full name +# ignore=title-trailing-punctuation, T3 + # verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this -verbosity = 2 +# verbosity = 2 + # By default gitlint will ignore merge commits. Set to 'false' to disable. -ignore-merge-commits=true +# ignore-merge-commits=true + +# By default gitlint will ignore fixup commits. Set to 'false' to disable. +# ignore-fixup-commits=true + +# By default gitlint will ignore squash commits. Set to 'false' to disable. +# ignore-squash-commits=true + +# Enable debug mode (prints more output). Disabled by default. +# debug=true # Set the extra-path where gitlint will search for user defined rules # See http://jorisroovers.github.io/gitlint/user_defined_rules for details # extra-path=examples/ -[title-max-length] -line-length=20 +# [title-max-length] +# line-length=80 -[title-must-not-contain-word] +# [title-must-not-contain-word] # Comma-separated list of words that should not occur in the title. Matching is case # insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING" # will not cause a violation, but "WIP: my title" will. -words=wip,title +# words=wip -[title-match-regex] +# [title-match-regex] # python like regex (https://docs.python.org/2/library/re.html) that the # commit-msg title must be matched to. # Note that the regex can contradict with other rules if not used correctly # (e.g. title-must-not-contain-word). -regex=^US[0-9]* +# regex=^US[0-9]* -[B1] +# [B1] # B1 = body-max-line-length -line-length=30 +# line-length=120 -[body-min-length] -min-length=5 +# [body-min-length] +# min-length=5 -[body-is-missing] +# [body-is-missing] # Whether to ignore this rule on merge commits (which typically only have a title) # default = True -ignore-merge-commits=false +# ignore-merge-commits=false -[body-changed-file-mention] +# [body-changed-file-mention] # List of files that need to be explicitly mentioned in the body when they are changed # This is useful for when developers often erroneously edit certain files or git submodules. # By specifying this rule, developers can only change the file when they explicitly reference # it in the commit message. -files=gitlint/rules.py,README.md +# files=gitlint/rules.py,README.md # [author-valid-email] # python like regex (https://docs.python.org/2/library/re.html) that the @@ -77,7 +89,7 @@ You can also use one or more ```-c``` flags like so: ``` $ gitlint -c general.verbosity=2 -c title-max-length.line-length=80 -c B1.line-length=100 ``` -The generic config flag format is ```-c .