diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.md | 6 | ||||
| -rw-r--r-- | docs/index.md | 5 | ||||
| -rw-r--r-- | docs/rules.md | 16 |
3 files changed, 24 insertions, 3 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 965c88d..973092a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,6 +1,8 @@ +# Contributing + We'd love for you to contribute to gitlint. Thanks for your interest! -Sometimes it takes a while for [me](https://github.com/jorisroovers) to -get back to you (this is a hobby project), but rest assured that we read your message and appreciate your interest! +Sometimes it takes a while for [me](https://github.com/jorisroovers) to get back to you (sometimes up to a few months, +this is a hobby project), but rest assured that we read your message and appreciate your interest! We maintain a [wishlist on our wiki](https://github.com/jorisroovers/gitlint/wiki/Wishlist), but we're obviously open to any suggestions! diff --git a/docs/index.md b/docs/index.md index 25509f2..4adb8a1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -257,6 +257,11 @@ regex=^Release(.*) ignore=title-max-length,body-min-length # ignore all rules by setting ignore to 'all' # ignore=all + +[ignore-by-title] +# Match commits message bodies that have a line that contains 'release' +regex=(.*)release(.*) +ignore=all ``` !!! note 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 |