Política: Mensagens de commit¶

Documentação em progresso

Pré-requisito¶

Para que as Mensagens de Commit Convencionais estejam funcionando com Pre-commit ⧉, é necessário garantir que tudo esteja instalado corretamente:

Você tem uma instalação nova e clonou o repositório seguindo as etapas descritas neste documento? não haverá problemas.
A pasta do seu projeto é antiga e clonada há muito tempo?
Certifique-se de remover quaisquer hooks commit-msg ou prepare-commit-msg anteriores que você possa ter dentro do diretório .git/hooks.
Instale manualmente o pre-commit ⧉ executando este comando:

Java Python Angular React

Documentação em progresso

pip3 install pre-commit

pre-commit install --hook-type pre-commit --hook-type pre-push

Documentação em progresso

Nos dois casos, você pode validar sua instalação local tentando commitar algo. (guia disponível aqui ⧉)

Mantemos alguns escopos personalizados para o projeto. Escopos válidos correspondem ao nome das funcionalidades.

Exemplos:

feat(escopo): ... → uma nova funcionalidade para escopo
fix(escopo): ... → uma correção de bug para a funcionalidade escopo
docs(escopo): ... → uma atualização da documentação da funcionalidade escopo
refactor(escopo): ... → uma refatoração interna da funcionalidade escopo sem alterações na assinatura pública
perf(escopo): ... → uma alteração de código que melhora o desempenho da funcionalidade escopo
test(escopo): ... → um novo teste ou correção de testes existentes para a funcionalidade escopo
build: ... → qualquer alteração nos scripts, configurações, dependências, etc
ci: ... → qualquer alteração na configuração relacionada ao servidor de Integração Contínua
revert: ... → reverter um commit mais antigo
chore: ... → qualquer alteração que não modifica os arquivos de código-fonte

Qualquer outra coisa não passará na validação executada pela esteira DevOps configurada para o projeto.

Para mais detalhes, acesse a documentação Conventional Commits ⧉.