This content originally appeared on DEV Community and was authored by Daniel Wildt
Para quem trabalha com Trunk Based Development, pode ser interessante poder olhar a listagem de commits e ter uma visão rápida do que está sendo atualizado na base de código.
Confesso que nos projetos que acompanho, minha lógica é: explique da forma mais objetiva possível o que é este commit. E claro, no contexto que busco trabalhar, sugiro commits pequenos. E frequentes.
Se fosse fazer uma decisão rápida, iria para três prefixos nas mensagens de commit: fix, feat e docs. Fix, olhando defeitos sendo corrigidos. Feat, no olhar de novas funcionalidades ou no caso de partes de novas funcionalidades. E docs, na atualização ou construção de documentação.
Se fosse poder escolher mais duas? Iria de test e ci. Test para indicar melhorias em testes, seja unitários, funcionais ou desempenho. E ci indicando tudo que poderia ser relacionado com melhoria do ciclo de deploy, validações, ferramentas de auditoria, build e deploy.
Agora, dá para ir bem mais longe. Antes de trazer mais exemplos de prefixos da indústria, deixo um exemplo de uma mensagem que poderia ser usada em um commit. Nos projetos pessoais, tenho usado esta:
feat: descrição rápida da funcionalidade closes #2
O meu próximo movimento é adicionar o módulo, pois os projetos vão ficar maiores. Assim consigo posicionar em que parte do código estou evoluindo.
feat(modulo): descrição rápida da funcionalidade closes #2
Agora, dependendo do que você prefere usar, dá para ir mais longe nas mensagens, exemplo:
feat(modulo): descrição rápida da funcionalidade
descrição mais completa da funcionalidade que foi desenvolvida.
closes #2
Nesta estrutura foca o cabeçalho com o tipo, módulo e descrição rápida. O corpo com a mensagem complementar. E o rodapé com a informação de fechamento de uma issue. Poderia também usar no rodapé "BREAKING CHANGE: explicação".
Para entender as opções de tipos de commits, a sugestão é usar como base os conventional commmits. Estas convenções são diretamente inspiradas nas convenções de contribuição do projeto Angular. Lá vão aparecer outras estruturas mais específicas, como build, perf e refactor.
Nos tipos de commit ainda dá para usar o "!" para indicar que está acontecendo uma "breaking change". Uma mudança que normalmente pode impactar o processo de atualização de sistemas. Como tenho preferido usar as mensagens mais curtas, vou pensar no uso de "!".
Que padrões fazem sentido nos seus projetos?
-- Daniel Wildt
P.S.: se você usa ferramentas para apoiar em ações de código, você pode ensinar estas ferramentas sobre os padrões a serem usados. E para padronizar nas equipes, se pode construir gatilhos para validar se a mensagem sendo usada na mensagem de commit segue o padrão esperado.
This content originally appeared on DEV Community and was authored by Daniel Wildt
Daniel Wildt | Sciencx (2025-10-25T21:40:43+00:00) Mensagem de commit?. Retrieved from https://www.scien.cx/2025/10/25/mensagem-de-commit/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.