@govbr-ds/commitlint-config NPM

GovBR-DS - Commit Config

Objetivo

Compartilhar os padrões de commit entre os projetos do GovBR-DS.

Como instalar

Instale as seguintes dependências

npm install --save-dev @govbr-ds/commitlint-config husky @commitlint/cz-commitlint

Como configurar

Crie um arquivo .commitlintrc.js na raiz do seu projeto e e importe a configuração:
```
export default {
  extends: ['@govbr-ds/commitlint-config'],
}
```

Inclua o seguinte código no seu package.json

  "scripts": {
    "commit": "git-cz",
  },
  "config": {
    "commitizen": {
      "path": "@commitlint/cz-commitlint"
    }
  }

Conforme a documentação do Husky inclua o hook commit-msg com o código abaixo:
```
npx commitlint --edit ${1}
```
E configure o package.json com o seguinte script:
```
  "scripts": {
    "prepare": "husky || true"
  }
```

Como contribuir?

Antes de abrir um Merge Request tenha em mente algumas informações:

Esse é um projeto opensource e contribuições são bem-vindas.
Para facilitar a aprovação da sua contribuição, escolha um título curto, simples e explicativo para o MR, e siga os padrões da nossa wiki.
Quer contribuir com o projeto? Confira o nosso guia como contribuir.

Reportar bugs/necessidades

Você pode usar as issues para nos informar os problemas que tem enfrentado ao usar nossa biblioteca ou mesmo o que gostaria que fizesse parte do projeto. Por favor use o modelo que mais se encaixa na sua necessidade e preencha com o máximo de detalhes possível.

Nos comprometemos a responder a todas as issues