diff --git a/.commitlintrc.yml b/.commitlintrc.yml index 037c7e6c71..b3c9af5774 100644 --- a/.commitlintrc.yml +++ b/.commitlintrc.yml @@ -1,8 +1,9 @@ extends: - "@commitlint/config-conventional" rules: - header-max-length: [1, 'always', 120] - body-max-length: [1, 'always', 150] - body-max-line-length: [1, 'always', 150] - footer-max-line-length: [1, 'always', 120] - subject-case: [1, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']] + header-max-length: [ 1, 'always', 120 ] + body-max-length: [ 1, 'always', 150 ] + body-max-line-length: [ 1, 'always', 150 ] + footer-max-line-length: [ 1, 'always', 120 ] + subject-case: [ 1, 'never', [ 'sentence-case', 'start-case', 'pascal-case', 'upper-case' ] ] + scope-enum: [ 2, 'always', [ 'esl-a11y-group', 'esl-alert', 'esl-animate', 'esl-base-element', 'esl-carousel','esl-event-listener','esl-footnotes','esl-forms','esl-image','esl-media','esl-media-query','esl-mixin-element','esl-open-state','esl-panel','esl-panel-group','esl-popup','esl-random-text','esl-related-target','esl-scrollbar','esl-share','esl-tab','esl-toggleable','esl-tooltip','esl-traversing-query','esl-trigger','esl-utils', 'site', 'deps', 'lint' ] ] diff --git a/docs/COMMIT_CONVENTION.md b/docs/COMMIT_CONVENTION.md index 4f03580bb1..c4a781209b 100644 --- a/docs/COMMIT_CONVENTION.md +++ b/docs/COMMIT_CONVENTION.md @@ -163,3 +163,50 @@ Update of css rules order. Close PR #123. ``` + +### \ + +Scope is an optional part of your commit message. + +Utilize a scope to clarify the area of changes. + +Scope should be enclosed in parentheses after the type but before :. + +Scope should be in lowercase. +```text +fix(esl-utils): Fixed IE compatibility for scroll type detection +``` + +**Permissible Scope Values** + +To ensure consistency and clarity in commit messages, the following are the permissible scope values: + +- esl-a11y-group +- esl-alert +- esl-animate +- esl-base-element +- esl-carousel +- esl-event-listener +- esl-footnotes +- esl-forms +- esl-image +- esl-media +- esl-media-query +- esl-mixin-element +- esl-open-state +- esl-panel +- esl-panel-group +- esl-popup +- esl-random-text +- esl-related-target +- esl-scrollbar +- esl-share +- esl-tab +- esl-toggleable +- esl-tooltip +- esl-traversing-query +- esl-trigger +- esl-utils +- site +- deps +- lint