@govbr-ds/commit-config NPM

GovBR-DS - Commit Config

Objetivo

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

Como instalar nossa biblioteca em seu projeto?

Instale as seguintes dependências

npm install --save-dev @govbr-ds/commit-config husky

Crie um arquivo commitlint.config.js na raiz do seu projeto e inclusa o seguinte:

module.exports = {
  extends: ['@govbr-ds/commit-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 para usar o hook commit-msg com o código abaixo:

npx --no -- commitlint --edit $1

Seguindo o padrão das configurações do commitlint é possível sobrescrever as configurações padrões deste pacote.

Como usar?

Antes de executar a ferramenta para guiar a criação dos commits execute o comando git git add. Depois disso basta executar o comando node npm run commit e você será guiado pela criação dos commits.

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