@govbr-ds/commitlint-config/README.md

Padrão de commits para projetos do Padrão Digital de Governo

# GovBR-DS - Commit Config

## Objetivo

Compartilhar os padrões de commit entre os projetos do [GovBR-DS](https://gitlab.com/govbr-ds 'GovBR-DS').

## Como instalar

1. Instale as seguintes dependências

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

## Como configurar

1. Crie um arquivo `.commitlintrc.js` na raiz do seu projeto e e importe a configuração:

   ```javascript
   export default {
     extends: ['@govbr-ds/commitlint-config'],
   }
   ```

1. Inclua o seguinte código no seu `package.json`

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

1. Conforme a documentação do [Husky](https://github.com/typicode/husky) inclua o hook `commit-msg` com o código abaixo:

   ```bash
   npx commitlint --edit ${1}
   ```

   E configure o `package.json` com o seguinte script:

   ```json
     "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](https://gov.br/ds/wiki/ 'Wiki').
- Quer contribuir com o projeto? Confira o nosso guia [como contribuir](../../CONTRIBUTING.md 'Como contribuir?').

## Reportar bugs/necessidades

Você pode usar as [issues](https://gitlab.com/govbr-ds/tools/govbr-ds-config-tools/-/issues/new) 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

## Precisa de ajuda?

> Por favor **não** crie issues para fazer perguntas...

Use nossos canais abaixo para obter tirar suas dúvidas:

- Site do GovBR-DS [http://gov.br/ds](http://gov.br/ds)

- Usando nosso canal no discord [https://discord.gg/U5GwPfqhUP](https://discord.gg/U5GwPfqhUP)

## Padrão de commits

Para mais informações sobre o padrão de commits consulte [a nossa Wiki](https://gov.br/ds/wiki/git-gitlab/guias/commit/ 'Padrão de commit').

## Licença

Nesse projeto usamos a licença MIT.