summaryrefslogtreecommitdiffstats
path: root/docs/rules.md
diff options
context:
space:
mode:
authorJoris Roovers <joris.roovers@gmail.com>2019-06-17 16:48:25 +0200
committerJoris Roovers <joris.roovers@gmail.com>2019-06-17 22:50:38 +0200
commit07738b3bd34f91977888a954f95527411babae1c (patch)
tree7501b832f981351d3608afb6a53912428b0fcc7b /docs/rules.md
parentd3bd68ccf42f24dacd40709eeac954c54ccaf331 (diff)
Docs for Contrib Rules
- Documented Contrib Rules: how to use them, how to write them Additional minor changes: - Renamed the ConventionalCommit id from CL1 to CT1 to align with existing conventions of using a 'T' for title rules. - Help output now wrapped at 120 chars instead of 80
Diffstat (limited to 'docs/rules.md')
-rw-r--r--docs/rules.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/rules.md b/docs/rules.md
index 9142337..d84da22 100644
--- a/docs/rules.md
+++ b/docs/rules.md
@@ -5,25 +5,25 @@ Note that you can also [write your own user-defined rule](user_defined_rules.md)
what you're looking for.
The rest of this page contains details on the available configuration options for each built-in rule.
-ID | Name | gitlint version | Description
-------|-----------------------------|---------------- |-------------------------------------------
-T1 | title-max-length | >= 0.1 | Title length must be &lt; 72 chars.
-T2 | title-trailing-whitespace | >= 0.1 | Title cannot have trailing whitespace (space or tab)
-T3 | title-trailing-punctuation | >= 0.1 | Title cannot have trailing punctuation (?:!.,;)
-T4 | title-hard-tab | >= 0.1 | Title cannot contain hard tab characters (\t)
-T5 | title-must-not-contain-word | >= 0.1 | Title cannot contain certain words (default: "WIP")
-T6 | title-leading-whitespace | >= 0.4 | Title cannot have leading whitespace (space or tab)
-T7 | title-match-regex | >= 0.5 | Title must match a given regex (default: .*)
-B1 | body-max-line-length | >= 0.1 | Lines in the body must be &lt; 80 chars
-B2 | body-trailing-whitespace | >= 0.1 | Body cannot have trailing whitespace (space or tab)
-B3 | body-hard-tab | >= 0.1 | Body cannot contain hard tab characters (\t)
-B4 | body-first-line-empty | >= 0.1 | First line of the body (second line of commit message) must be empty
-B5 | body-min-length | >= 0.4 | Body length must be at least 20 characters
-B6 | body-is-missing | >= 0.4 | Body message must be specified
-B7 | body-changed-file-mention | >= 0.4 | Body must contain references to certain files if those files are changed in the last commit
-M1 | author-valid-email | >= 0.9 | Author email address must be a valid email address
-
-
+ID | Name | gitlint version | Description
+------|-----------------------------|-------------------|-------------------------------------------
+T1 | title-max-length | >= 0.1.0 | Title length must be &lt; 72 chars.
+T2 | title-trailing-whitespace | >= 0.1.0 | Title cannot have trailing whitespace (space or tab)
+T3 | title-trailing-punctuation | >= 0.1.0 | Title cannot have trailing punctuation (?:!.,;)
+T4 | title-hard-tab | >= 0.1.0 | Title cannot contain hard tab characters (\t)
+T5 | title-must-not-contain-word | >= 0.1.0 | Title cannot contain certain words (default: "WIP")
+T6 | title-leading-whitespace | >= 0.4.0 | Title cannot have leading whitespace (space or tab)
+T7 | title-match-regex | >= 0.5.0 | Title must match a given regex (default: .*)
+B1 | body-max-line-length | >= 0.1.0 | Lines in the body must be &lt; 80 chars
+B2 | body-trailing-whitespace | >= 0.1.0 | Body cannot have trailing whitespace (space or tab)
+B3 | body-hard-tab | >= 0.1.0 | Body cannot contain hard tab characters (\t)
+B4 | body-first-line-empty | >= 0.1.0 | First line of the body (second line of commit message) must be empty
+B5 | body-min-length | >= 0.4.0 | Body length must be at least 20 characters
+B6 | body-is-missing | >= 0.4.0 | Body message must be specified
+B7 | body-changed-file-mention | >= 0.4.0 | Body must contain references to certain files if those files are changed in the last commit
+M1 | author-valid-email | >= 0.9.0 | Author email address must be a valid email address
+I1 | ignore-by-title | >= 0.10.0 | Ignore a commit based on matching its title
+I2 | ignore-by-body | >= 0.10.0 | Ignore a commit based on matching its body
## T1: title-max-length ##