Skip to content

CT1: contrib-title-conventional-commits do not support the BREAKING CHANGE symbol "!" #186

@linjiX

Description

@linjiX

According to the Conventional Commits

BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.

If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.

But gitlint reports error if adding ! after the scope:

$ echo 'test(scope)!: title' | gitlint --contrib=CT1 -c general.ignore=body-is-missing
1: CT1 Title does not follow ConventionalCommits.org format 'type(optional-scope): description': "test(scope)!: title"

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementUser-facing feature enhancements

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions