Skip to main content
Version: v4

non-conventional-commits

non-conventional-commits spots pull requests with some commit messages not complying with the Conventional Commits specification.

Adhering to the Conventional Commits specification in pull request commit messages can greatly enhance clarity, consistency, and overall project management. This specification involves structured commit messages that clearly define the purpose and impact of each commit, thereby facilitating an easy understanding of the changes made. This not only aids in code review by providing valuable context to reviewers, but it also supports automated tools in generating meaningful release notes, version bumps, or changelogs.

Parameters

No parameter

Default Configuration

checks:
non-conventional-commits:
label: non-conventional-commits
activation: off