commitlint-config-seek

Shareable commitlint configuration for SEEK, designed to support usage of semantic-release.

This configuration uses the conventional commit format, with a couple of exceptions:

• Scopes are case insensitive (rather than lower case), most notably to support React components, e.g. fix(Button): ...
• Subjects are sentence case (rather than lower case), because it (arguably) improves readability.

Usage

You can set this up a few different ways, easiest is probably just adding it into your package.json like so:

{
  "commitlint": {
    "extends": [
      "seek"
    ]
  }
}

Examples

Patch release:

fix(Button): Remove drop shadow from buttons

Minor release:

feat(Button): Add 'ghost' button style

Major release:

feat(Button): Add 'primary' button style

BREAKING CHANGE: The 'color' prop has been removed

License

MIT.