.gitlint

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