Important

This repository has moved. @andrewmcodes/commitlint-config is now developed and published from the andrewmcodes/js-configs monorepo. This repository is archived and read-only — please open issues and pull requests in js-configs. The npm package name is unchanged.

@andrewmcodes/commitlint-config

This is a shareable commitlint configuration, which includes a set of preferred styling rules that can be easily extended.

Installation

# npm
npm install --save-dev @andrewmcodes/commitlint-config
# yarn
yarn add -D @andrewmcodes/commitlint-config

Usage

Add the following to your commitlint.config.js:

// commitlint.config.js
module.exports = {
  extends: ["@andrewmcodes"], // => @andrewmcodes/commitlint-config
};

Contributing

I'd love your help refining this package. Please don't hesitate to send a pull request.

Code Style

Run yarn format before committing to ensure your changes comply with our coding style.

Commit Messages

This project uses Conventional Commits. Please make sure your commit messages follow this format.