Guilherme Jun, ICMC Júnior Out/2021
Boas práticas de escrita de commit
- Commitar códigos completos
- Fazer commits pequenos
- Não misturar várias coisas em um commit só
- Mensagens de commit
- Inglês
- Usar o imperativo
- "update documentation" (atualize a documentação)
- "fix duplicate data" (corrija dados duplicados)
- Não fazer um commit muito longo
- Mais dicas: https://chris.beams.io/posts/git-commit/
Conventional Commits
-
Padronização de escrita de commits
-
Conexão com o SemVer
- Padronização dos números de versão de projetos
- MAJOR.MINOR.PATCH
- Ex: 2.3.1
-
Estrutura:
<tipo>(<escopo opcional>): <descrição>
<corpo opcional>
<rodapé opcional>
-
Tipos:
- feat: nova feature
- fix: consertar bug
- Outros (que se baseam no Angular): build, chore, ci, docs, style, refactor, perf, test
-
Escopo: contexto do commit, arquivos / blocos de códigos que foram alterados
-
Rodapé
- Informa se tem Breaking Changes (mudança de versões)
- Informa qual issue foi resolvida (ex: #22)
-
https://www.conventionalcommits.org/en/v1.0.0/
Ferramentas
Commitizen-CLI
- Uso de CLI (interface na linha de comandos) para automatizar a criação de commits utilizando a estrutura do Conventional Commits
Commitlint