diff options
Diffstat (limited to 'gitlint/files/gitlint')
| -rw-r--r-- | gitlint/files/gitlint | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/gitlint/files/gitlint b/gitlint/files/gitlint index 15a6626..e95bf9e 100644 --- a/gitlint/files/gitlint +++ b/gitlint/files/gitlint @@ -4,7 +4,7 @@ # one rule and each key in it is an option for that specific rule. # # Rules and sections can be referenced by their full name or by id. For example -# section "[body-max-line-length]" could be written as "[B1]". Full section names are +# section "[body-max-line-length]" could also be written as "[B1]". Full section names are # used in here for clarity. # # [general] @@ -43,6 +43,11 @@ # [title-max-length] # line-length=50 +# Conversely, you can also enforce minimal length of a title with the +# "title-min-length" rule: +# [title-min-length] +# min-length=5 + # [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" @@ -50,8 +55,7 @@ # words=wip # [title-match-regex] -# python like regex (https://docs.python.org/2/library/re.html) that the -# commit-msg title must be matched to. +# python-style regex that the commit-msg title must match # Note that the regex can contradict with other rules if not used correctly # (e.g. title-must-not-contain-word). # regex=^US[0-9]* @@ -74,9 +78,13 @@ # it in the commit message. # files=gitlint/rules.py,README.md +# [body-match-regex] +# python-style regex that the commit-msg body must match. +# E.g. body must end in My-Commit-Tag: foo +# regex=My-Commit-Tag: foo$ + # [author-valid-email] -# python like regex (https://docs.python.org/2/library/re.html) that the -# commit author email address should be matched to +# python-style regex that the commit author email address must match. # For example, use the following regex if you only want to allow email addresses from foo.com # regex=[^@]+@foo.com @@ -98,9 +106,14 @@ # Use 'all' to ignore all rules # ignore=T1,body-min-length +# [ignore-body-lines] +# Ignore certain lines in a commit body that match a regex. +# E.g. Ignore all lines that start with 'Co-Authored-By' +# regex=^Co-Authored-By + # This is a contrib rule - a community contributed rule. These are disabled by default. # You need to explicitly enable them one-by-one by adding them to the "contrib" option # under [general] section above. # [contrib-title-conventional-commits] # Specify allowed commit types. For details see: https://www.conventionalcommits.org/ -# types = bugfix,user-story,epic
\ No newline at end of file +# types = bugfix,user-story,epic |