O que é compromisso convencional?

Daniel Barriga GradosArquiteto e desenvolvedor Front-End e Scrum Master em VIEWNEXT

[alcance opcional]: 

Nesta linha “» indicar o tipo de alteração realizada no código (como fix, feat, docs, style, etc.), “[alcance opcional]» indique a parte do código afetada pela alteração (opcional) y “» é uma breve descrição da mudança realizada.

Perdido Compromissos Convencionais Eles se concentram em três tipos principais de mudanças: correções de erros (correções), novas características (feat) e mudanças na documentação (docs). Além disso, existem também outros tipos de alterações definidas, como melhorias de performance (perf), alterações na estrutura do código (refactor), alterações na configuração (config), entre outras.

Por que o commit convencional é importante

Os compromissos convencionais são importantes por vários motivos:

1. Consistência: A convenção de Os commits convencionais estabelecem um formato padrão para mensagens de commit, o que facilita a leitura e compreensão das alterações feitas no código. Além disso, ajuda a manter uma estrutura clara e consistente nas mensagens de commit, o que facilita a busca de mudanças específicas no histórico do Git.
2. Automação: Permite a automatização de certas tarefas, como a geração de notas de versão ou a criação de relatórios de mudanças. Ao usar uma convenção consistente para as mensagens de commit, você pode escrever um software que processe automaticamente as mudanças realizadas no código e gere informações detalhadas para a equipe de desenvolvimento e outras partes interessadas.
3. Colaboração: Por último, fomentar a colaboração entre os membros da equipe de desenvolvimento. Ao usar uma convenção consistente para as mensagens de commit, facilita a revisão das mudanças realizadas no código por outros membros do equipamento. Além disso, ao ter uma estrutura clara e consistente nas mensagens de commit, facilita a comunicação entre os membros da equipe e reduz a possibilidade de mal-entendidos.

El Compromisso Convencional é importante porque ajuda a padronizar o histórico de mudanças do repositório. Com um formato estruturado e consistente, é mais fácil para os desenvolvedores compreenderem as mudanças que foram realizadas no repositório, seja no presente ou no futuro. Além disso, o Compromisso Convencional facilita a geração de relatórios e estatísticas sobre o desenvolvimento do projeto, o que pode ajudar os gerentes de projeto a tomar decisões informadas.

Outra vantagem do Compromisso Convencional é que é compatível com ferramentas de automação e plug-ins que podem melhorar o fluxo de trabalho. Em particular, os plug-ins conectados com ferramentas de integração contínua (CI) e entrega contínua (CD) podem aprovar mensagens de confirmação estruturadas para automatizar tarefas, como geração de versões e criação de etiquetas.

Plug-ins para commit convencional

Existem vários plug-ins disponível para o compromisso convencional que pode ajudar os desenvolvedores a aproveitar suas vantagens. A seguir, são descritos alguns dos mais populares.

Comprometer-se

Commitizen é um plug-in que fornece uma interface de linha de comando para orientar os desenvolvedores através do processo de confirmação seguindo o formato Convencional Commit. Quando o comando “git commit” é executado, o Commitizen fornece uma série de perguntas para ajudar os desenvolvedores a completar a mensagem de confirmação. de forma consistente e estruturada.

Husky

Husky é um plug-in que Ele se integra ao Git para executar scripts de pré-commit e pós-commit. Isso significa que scripts personalizados podem ser adicionados para validar a mensagem de confirmação antes de confirmar. Por exemplo, você pode adicionar scripts para verificar se a mensagem de confirmação segue o formato do Commit Convencional ou para verificar se o código está cumprido com certas regras de estilo.

Liberação semântica

A liberação semântica é um plug-in que automatiza a publicação de novas versões do projeto com base em mensagens de confirmação. O plug-in analisa as mensagens de confirmação para determinar o nível semântico da versão, como principal, secundária ou patch. Luego, gere automaticamente uma nova versão e crie um rótulo no repositório. Você também pode publicar automaticamente a nova versão no repositório de pacotes ou no repositório Docker.

Empenhado

Commitlint é um plug-in que É usado para validar o formato das mensagens de confirmação no repositório. Com o Commitlint, você pode definir especificamente o formato das mensagens de confirmação, o que ajuda a garantir que todos os desenvolvedores sigam o mesmo formato e que o histórico de mudanças seja consistente. Além disso, Commitlint Integra-se com vários editores de código, como Visual Studio Codepara mostrar avisos em tempo real quando for escrita uma mensagem de confirmação que não cumpra as regras definidas.

Conclusão

O compromisso convencional é um padrão de nomenclatura para mensagens de confirmação que ajuda a padronizar e estruturar o histórico de alterações no repositório. Ao usá-lo, os desenvolvedores podem compreender de maneira clara e concisa o que foi mudado no repositório, o que facilita a colaboração em equipe e a tomada de decisões informadas. Além disso, plug-ins de Commit Convencional, como Commitizen, Husky, Semantic-release e Commitlint, podem automatizar e melhorar o fluxo de trabalho dos desenvolvedores. Em conjunto, o Commit Convencional e os plug-ins podem ajudar os desenvolvedores a criar um histórico de mudanças consistente e fácil de seguir, o que pode melhorar a eficiência e a qualidade do software desenvolvido.