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