Como escrever uma boa mensagem de commit

Aprenda como escrever uma boa mensagem de commit e tenha o controle do código que escreveu de maneira mais simples.

Uma boa mensagem de commit deve deixar muito claro tudo o que foi feito.

Dessa forma fica mais fácil identificar quais foram as mudanças feitas sem que tenham que ver o código.

O que pode poupar muito tempo na busca de uma alteração que foi feita.

Por mais que seja em um projeto pessoal uma boa mensagem de commit é importante.

Ainda mais se é um projeto que você não trabalha com frequência.

Eu uso o seguinte padrão:

Tipo: Descrição curta

Descrição detalhada (se necessário)

Referência a um registro de bug ou de chamado.

Tipo

Para os tipos eu gosto de separar em 6, são eles.

• Feature – Quando é desenvolvimento de uma nova funcionalidade.
• Fix – Quando se trata de uma correção de bug.
• Docs – Quando se trata só de uma alteração na documentação, como uma atualização no README, por exemplo.
• Style – Quando mudo só folhas de estilo (CSS).
• Refactor – Quando refatoro completamente um trecho de código.
• Test – Quando o foram escritos ou corrigidos somente testes.

Descrição Curta

Aqui como o próprio nome diz eu coloco uma curta descrição do que foi feito.

Aqui eu tento manter no máximo 50 caracteres.

Dessa forma mantendo somente com um assunto, dando uma ideia geral do que se trata a mudança.

Exemplo:
Criação controller XPTO

Descrição Detalhada

Em casos de códigos mais complexos costumo descrever melhor as alterações feitas.

Mas vale lembrar, nada substitui uma documentação bem escrita.

Só que eu não costumo criar sempre descrições detalhadas para todos os commits.

Por exemplo uma mudança de documentação não necessita de explicações.

Por outro lado uma refatoração ou uma implementação nova vale a pena uma boa descrição.

Exemplo:
Criação da nova validação de idade do usuário, usando flunt notification

Referência a bug

É possível rastrear bugs diretamente no commit.

Para fazer isso é só adicionar o número do bug com um # antes do código.

#123 por exemplo.

Dessa forma fica mais fácil de rastrear os bugs.

No entanto nem todas ferramentas permitem esse rastreio.

Então por isso não uso sempre essa referência.

Mas para as principais ferramentas como Jira e Azure DevOps permitem esse tipo de integração e permitem que você rastreie a correção do bug diretamente do board.

Como escrever uma boa mensagem de commit – Exemplo

Refactor: Mudança no método de autenticação

Mudança no método de autenticação que agora passa a usar um token JWT para validação de usuário e suas devidas permissões.

Resolve: #123

Veja mais exemplos no Conventional Commits.

Como escrever uma boa mensagem de commit – Conclusão

Em resumo mostrei a você o modelo que eu uso para fazer uma boa mensagem de commit.

Sem dúvida uma boa mensagem de commit é importante.

Só que de nada adianta uma boa mensagem de commit e criar aquele commit bomba com código de dois meses.

Se você está começando agora na área de programação, nosso curso de programação full stack é perfeito para você!

Com um conteúdo didático e acessível, você aprenderá desde os conceitos básicos até as tecnologias mais avançadas. Inscreva-se agora e comece sua jornada rumo ao sucesso na programação.

Confira mais dicas sobre desenvolvimento aqui.