Skip to content

Commit 0281f55

Browse files
authored
docs: better description of ignores (#3692)
1 parent 692739f commit 0281f55

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

docs/reference-configuration.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,20 @@ const Configuration = {
4040
'type-enum': [2, 'always', ['foo']],
4141
},
4242
/*
43-
* Functions that return true if commitlint should ignore the given message.
43+
* Array of functions that return true if commitlint should ignore the given message.
44+
* Given array is merged with predefined functions, which consist of matchers like:
45+
*
46+
* - 'Merge pull request', 'Merge X into Y' or 'Merge branch X'
47+
* - 'Revert X'
48+
* - 'v1.2.3' (ie semver matcher)
49+
* - 'Automatic merge X' or 'Auto-merged X into Y'
50+
*
51+
* To see full list, check https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/is-ignored/src/defaults.ts.
52+
* To disable those ignores and run rules always, set `defaultIgnores: false` as shown below.
4453
*/
4554
ignores: [(commit) => commit === ''],
4655
/*
47-
* Whether commitlint uses the default ignore rules.
56+
* Whether commitlint uses the default ignore rules, see the description above.
4857
*/
4958
defaultIgnores: true,
5059
/*

0 commit comments

Comments
 (0)