.gitlint

   1 # All these sections are optional, edit this file as you like.
   2 [general]
   3 # Ignore certain rules, you can reference them by their id or by their full
   4 # name
   5 # ignore=title-trailing-punctuation, T3
   6 # verbosity should be a value between 1 and 3, the command line -v flags take
   7 # precedence over this
   8 # verbosity = 2
   9 # By default gitlint will ignore merge commits. Set to 'false' to disable.
  10 # ignore-merge-commits=true
  11 # By default gitlint will ignore fixup commits. Set to 'false' to disable.
  12 # ignore-fixup-commits=true
  13 # By default gitlint will ignore squash commits. Set to 'false' to disable.
  14 # ignore-squash-commits=true
  15 # Enable debug mode (prints more output). Disabled by default.
  16 # debug=true
  17 # Set the extra-path where gitlint will search for user defined rules
  18 # See http://jorisroovers.github.io/gitlint/user_defined_rules for details
  19 # extra-path=examples/
  20 # contrib=contrib-title-conventional-commits,contrib-body-requires-signed-off-b
  21 contrib=contrib-body-requires-signed-off-by
  22 [title-max-length]
  23 # line-length=80
  24 line-length=50
  25 # [title-must-not-contain-word]
  26 # Comma-separated list of words that should not occur in the title. Matching is
  27 # case insensitive. It's fine if the keyword occurs as part of a larger word
  28 # (so "WIPING" will not cause a violation, but "WIP: my title" will.
  29 # words=wip
  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 [B1]
  37 # B1 = body-max-line-length
  38 # line-length=120
  39 line-length=72
  40 # [body-min-length]
  41 # min-length=5
  42 # [body-is-missing]
  43 # Whether to ignore this rule on merge commits (which typically only have a title)
  44 # default = True
  45 # ignore-merge-commits=false
  46 # [body-changed-file-mention]
  47 # List of files that need to be explicitly mentioned in the body when they are
  48 # changed This is useful for when developers often erroneously edit certain
  49 # files or git submodules.  By specifying this rule, developers can only change
  50 # the file when they explicitly reference it in the commit message.
  51 # files=gitlint/rules.py,README.md
  52 # [author-valid-email]
  53 # python like regex (https://docs.python.org/2/library/re.html) that the
  54 # commit author email address should be matched to
  55 # For example, use the following regex if you only want to allow email
  56 # addresses from foo.com
  57 # regex=[^@]+@foo.com
  58 # [ignore-by-title]
  59 # Ignore certain rules for commits of which the title matches a regex
  60 # E.g. Match commit titles that start with "Release"
  61 # regex=^Release(.*)
  62 #
  63 # Ignore certain rules, you can reference them by their id or by their full name
  64 # Use 'all' to ignore all rules
  65 # ignore=T1,body-min-length
  66 # [ignore-by-body]
  67 # Ignore certain rules for commits of which the body has a line that matches a
  68 # regex
  69 # E.g. Match bodies that have a line that contain "release"
  70 # regex=(.*)release(.*)
  71 #
  72 # Ignore certain rules, you can reference them by their id or by their full name
  73 # Use 'all' to ignore all rules
  74 # ignore=T1,body-min-length
  75 # Enable Conventional Commit subject line enforcement
  76 # https://www.conventionalcommits.org/en/v1.0.0/
  77 #
  78 # Since we want all subjects to be well formed, enforce the topics
  79 # to the following (fairly standard) topics and require them to be Mixed Case
  80 #[contrib-title-conventional-commits]
  81 #types=Fix,Feat,Chore,Docs,Style,Refactor,Perf,Test,Revert,CI,Build