https://github.com/pixelmatters/commitlint-config-pixelmatters

Pixelmatters' config for commitlint
https://github.com/pixelmatters/commitlint-config-pixelmatters

Last synced: about 1 month ago
JSON representation

Pixelmatters' config for commitlint

• Host: GitHub
• URL: https://github.com/pixelmatters/commitlint-config-pixelmatters
• Owner: Pixelmatters
• License: mit
• Created: 2021-04-27T10:43:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-04T16:02:06.000Z (11 months ago)
• Last Synced: 2024-12-09T22:40:31.504Z (about 1 month ago)
• Language: JavaScript
• Size: 80.1 KB
• Stars: 0
• Watchers: 19
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

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:

1. Install the package as a development dependency:

```shell

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

```

### **NPM**

If using NPM:

1. Install the package as a development dependency:

```shell

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

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

``` js

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**](https://github.com/Pixelmatters/commitlint-config-pixelmatters/blob/master/CONTRIBUTING.md) for ideas on contributing and setup steps.

## :memo: License

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