README.md

commitlint-config-traverson

shareable config for commitlint

Purpose

This is a shareable config for commitlint, which helps us ensure our commits are compatible with semantic-release.

This config extends commitlint-config-travi.

Usage

Installation

$ npm install commitlint-config-traverson --save-dev

Define the config for your project

$ echo "module.exports = {extends: ['traverson']};" > .commitlintrc.js

Define the husky hook

(in a .huskyrc.json, for example)

{
  "hooks": {
    "commit-msg": "commitlint -e"
  }
}

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test