@braineet/lint-staged-config/README.md

Shared lint-staged configuration for Braineet Frontend projects

# Braineet - Frontend Tools - Commitlint configuration <!-- omit in toc -->

Shared Commitlint configuration for Braineet Frontend projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @braineet/commitlint-config @commitlint/cli cz-git
```

Update your commitlint config file

```shell
const braineetCommitLintConfig = require('@braineet/commitlint-config');
module.exports = braineetCommitLintConfig;
```

Create .czrc

```shell
{
    "path": "node_modules/cz-git"
}
```