Skip to content

Commit

Permalink
docs: better description of ignores (#3692)
Browse files Browse the repository at this point in the history
  • Loading branch information
arxeiss authored Oct 10, 2023
1 parent 692739f commit 0281f55
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/reference-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,20 @@ const Configuration = {
'type-enum': [2, 'always', ['foo']],
},
/*
* Functions that return true if commitlint should ignore the given message.
* Array of functions that return true if commitlint should ignore the given message.
* Given array is merged with predefined functions, which consist of matchers like:
*
* - 'Merge pull request', 'Merge X into Y' or 'Merge branch X'
* - 'Revert X'
* - 'v1.2.3' (ie semver matcher)
* - 'Automatic merge X' or 'Auto-merged X into Y'
*
* To see full list, check https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/is-ignored/src/defaults.ts.
* To disable those ignores and run rules always, set `defaultIgnores: false` as shown below.
*/
ignores: [(commit) => commit === ''],
/*
* Whether commitlint uses the default ignore rules.
* Whether commitlint uses the default ignore rules, see the description above.
*/
defaultIgnores: true,
/*
Expand Down

0 comments on commit 0281f55

Please sign in to comment.