diff options
Diffstat (limited to 'docs/rules.md')
| -rw-r--r-- | docs/rules.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docs/rules.md b/docs/rules.md index 47e9483..9142337 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -183,7 +183,6 @@ regex | >= 0.9.0 | ```[^@ ]+@[^@ ]+\.[^@ ]+``` | Rege An often recurring use-case is to only allow email addresses from a certain domain. The following regular expression achieves this: ```[^@]+@foo.com``` - ## I1: ignore-by-title ## ID | Name | gitlint version | Description @@ -197,3 +196,18 @@ Name | gitlint version | Default | Descr ----------------------|-------------------|------------------------------|---------------------------------- regex | >= 0.10.0 | None | Regex to match against commit title. On match, the commit will be ignored. ignore | >= 0.10.0 | all | Comma-seperated list of rule names or ids to ignore when this rule is matched. + + +## I2: ignore-by-body ## + +ID | Name | gitlint version | Description +------|-----------------------------|-----------------|------------------------------------------- +I2 | ignore-by-body | >= 0.10.0 | Ignore a commit based on matching its body. + + +### Options ### + +Name | gitlint version | Default | Description +----------------------|-------------------|------------------------------|---------------------------------- +regex | >= 0.10.0 | None | Regex to match against each line of the body. On match, the commit will be ignored. +ignore | >= 0.10.0 | all | Comma-seperated list of rule names or ids to ignore when this rule is matched.
\ No newline at end of file |