@di-unternehmer/commitlint-plugin-salesapp
v1.0.1
Published
Configuration for linting commit messages
Downloads
7
Keywords
Readme
Plugin for commitlint
Commitlint plugin to adapt the linting to our needs in the salesapp team.
For more information about commitlint see: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
Added rules and adapted parser-preset
The defined header types are:
- breaking
- type
- scope
- ticket
- subject
Issue prefix: #
Commit Message Header Pattern
The header (1st line) of a commit message has to follow this pattern:
header: (breaking?)type(scope?) [jira-ticket-number]: Not more then 72 chars in total on first line
The scope
and breaking
, inclusive the ()
, are optional.
The breaking
change is shown with !!!
before the type.
The []
and the ticket number is mandatory as well as :
inclusive a space before the sentence begins
The [jira-ticket-number]
has to follow the rule:
- 1-3 uppercase letters
- hyphen
- 1-4 digits EXAMPLE: A-1 to XXX-9999
Example
header pattern: type(scope?) [XX-123]: Not more then 72 chars in total on first line
Breaking Change:
header pattern: !!!type(scope?) [XXX-1234]: Not more then 72 chars in total on first line
Commit message example:
FEATURE(api) [SWN-1]: Headline of the ticket - or more helpfull message
Breaking Change:
!!!FEATURE(api) [SWN-1]: Headline of the ticket - or more helpfull message