Skip to content

Shareable config for linting commit messages.

License

Notifications You must be signed in to change notification settings

socifi/commitlint-config

Repository files navigation

Commitlint Config

npm version CircleCI

Shareable config for commitling.

How to use

Create commitlint.config.js file and enter following config:

module.exports = {
    extends: ['@socifi/commitlint-config'],
};

Format of Commit message

Changed: CON-865 Some change in code.

Type

Following types are allowed:

  • Changed
  • Fixed
  • Removed
  • Added
  • Depreciated
  • Docs
  • Refactored
  • Test - should not be in master branch
  • InProgress, WIP - should not be in master branch

Reference

Reference to JIRA issue. eg. CON-156. It is recommended but not required.

Commit message

MUST exist.