@pixelmatters/commitlint-config-pixelmatters

CommitLint config for usage in Pixelmatters projects

Usage no npm install needed!

<script type="module">
  import pixelmattersCommitlintConfigPixelmatters from 'https://cdn.skypack.dev/@pixelmatters/commitlint-config-pixelmatters';
</script>

README

commitlint-config-pixelmatters

An CommitLint config standard for Pixelmatters projects

This is a CommitLint config that you can use in your projects.

🚀 Get Up and Running

You can install this package using either npm or yarn.

Yarn

If using Yarn:

Install the package as a development dependency:

yarn add @pixelmatters/commitlint-config-pixelmatters --dev

NPM

If using NPM:

Install the package as a development dependency:

npm install @pixelmatters/commitlint-config-pixelmatters --save-dev

Install commitizen if it's not already installed

Great guide on pixelmatters basecamp: https://www.notion.so/pixelmatters/Conventional-Commits-Dynamic-Changelog-3138a2ce8ff343229125fd6f3144f395

Create a config file

Create an .commitlint.config.js file in the root of your project and add the following code:

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

At this point you should be good to go 👍

🤝 How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, thank you! 💪 🧡

Check out our Contributing Guide for ideas on contributing and setup steps.

:memo: License

Licensed under the MIT License. Based on config-conventional: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional