Skip to content

commits/commitlint

Checks a new commit message for a conventional type, an optional known scope, a first line of 72 characters or fewer, and a wrapped body.

Part of the commits configuration, at the all level. It runs at the message stage, per file. It runs commitlint.

Release notes, blame, and bisect depend on typed, scoped subjects, and a free-form message hides the change.

Write <type>: <subject> or <type>(<scope>): <subject> in a first line of 72 characters or fewer. Change the accepted types with gspot set tools.commitlint.types.

The message changed stuff has no type or scope. Write fix(cli): report missing configuration instead.

Turn it off for some files, or one of its lint rules, with a reason:

gspot ignore commits/commitlint --paths "<glob>" --reason "<why>"
gspot ignore commits/commitlint --rule <rule> --reason "<why>"