From a4dc387bfbc56ba97701bfdde34b033ada9bb5c1 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 19 Apr 2021 15:27:13 +0200 Subject: Merging upstream version 0.15.1. Signed-off-by: Daniel Baumann --- docs/contrib_rules.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/contrib_rules.md') diff --git a/docs/contrib_rules.md b/docs/contrib_rules.md index e376fb8..336e42a 100644 --- a/docs/contrib_rules.md +++ b/docs/contrib_rules.md @@ -10,7 +10,7 @@ re-implement these commonly used rules themselves as [user-defined](user_defined To enable certain contrib rules, you can use the `--contrib` flag. ```sh $ cat examples/commit-message-1 | gitlint --contrib contrib-title-conventional-commits,CC1 -1: CC1 Body does not contain a 'Signed-Off-By' line +1: CC1 Body does not contain a 'Signed-off-by' line 1: CL1 Title does not start with one of fix, feat, chore, docs, style, refactor, perf, test: "WIP: This is the title of a commit message." # These are the default violations @@ -41,7 +41,7 @@ You can also configure contrib rules using [any of the other ways to configure g ID | Name | gitlint version | Description ------|-------------------------------------|------------------ |------------------------------------------- CT1 | contrib-title-conventional-commits | >= 0.12.0 | Enforces [Conventional Commits](https://www.conventionalcommits.org/) commit message style on the title. -CC1 | contrib-requires-signed-off-by | >= 0.12.0 | Commit body must contain a `Signed-Off-By` line. +CC1 | contrib-body-requires-signed-off-by | >= 0.12.0 | Commit body must contain a `Signed-off-by` line. ## CT1: contrib-title-conventional-commits ## @@ -56,11 +56,11 @@ Name | gitlint version | Default | Description types | >= 0.12.0 | `fix,feat,chore,docs,style,refactor,perf,test,revert,ci,build` | Comma separated list of allowed commit types. -## CC1: contrib-requires-signed-off-by ## +## CC1: contrib-body-requires-signed-off-by ## ID | Name | gitlint version | Description ------|---------------------------------------|--------------------|------------------------------------------- -CC1 | contrib-requires-signed-off-by | >= 0.12.0 | Commit body must contain a `Signed-Off-By` line. This means, a line that starts with the `Signed-Off-By` keyword. +CC1 | contrib-body-requires-signed-off-by | >= 0.12.0 | Commit body must contain a `Signed-off-by` line. This means, a line that starts with the `Signed-off-by` keyword. ## Contributing Contrib rules -- cgit v1.2.3