Article image

CS

Carlos Silva17/08/2023 13:25
Compartilhe

Conventional Commits: Escrevendo Commits como um Profissional

  • #GitHub
  • #Git

Olá pessoal, hoje irei falar sobre Conventional Commits. Será uma explicação simples para você começar a aplicá-los no seu próximo projeto.

O que são Conventional Commits?

É uma convenção de nomenclatura para dar mais significado aos seus commits e ajudar na organização dos mesmos. Ele segue a seguinte estrutura:

<tipo>: <descrição>

Por exemplo:

feat: adiciona tela de login

Exemplo real:

image

Vantagens

  • Determinar automaticamente alterações no versionamento semântico (com base nos tipos de commits).
  • Comunicar a natureza das mudanças para colegas de equipe, o público e outras partes interessadas.
  • Facilitar a contribuição de outras pessoas em seus projetos, permitindo que eles explorem um histórico de commits melhor estruturado.

Tipos de commits

Esses são os principais tipos, você poderá ver mais no site oficial do convetional commits no link ao final do artigo.

  • ✨ feat

O tipo feat é utilizado para indicar a adição de uma nova funcionalidade ou feature no código. Esta funcionalidade pode ser algo completamente novo ou uma extensão de uma funcionalidade existente. É importante notar que o tipo feat não deve ser utilizado para correções de bugs ou erros. Para isso, existem outros tipos específicos, como fix. Ao utilizar o Conventional Commits, a adição de uma nova funcionalidade no código é facilmente identificável através da tag feat.

  • 🐛 fix

O tipo fix é usado para indicar uma correção de erro no código. Isso pode incluir a solução de um bug, patch de segurança ou outras melhorias que corrijam problemas existentes no código. Ao utilizar o Conventional Commits, a correção de um erro no código é facilmente identificável através da tag fix.

  • 📚 docs

O tipo docs é utilizado quando há alterações na documentação do projeto, seja ela interna ou externa. Isso inclui alterações no README, documentação de código, comentários, etc. Ao utilizar o Conventional Commits, as atualizações na documentação do projeto são facilmente identificáveis através da tag docs. A documentação clara e precisa é fundamental para manter a qualidade do projeto e facilitar a colaboração entre os membros da equipe.

  • 💄 style

O tipo style é utilizado para indicar mudanças apenas de estilo no código, como por exemplo, alterações em espaçamentos, indentação, quebra de linha, etc. Esse tipo de mudança não deve afetar a lógica do código em si. Ao utilizar o Conventional Commits, as mudanças de estilo no código são facilmente identificáveis através da tag style.

  • 🛠️ refactor

O tipo refactor é utilizado para indicar mudanças no código que não adicionam novas funcionalidades nem corrigem erros, mas que melhoram a estrutura ou organização do código em si. Isso pode incluir a renomeação de variáveis, a extração de funções, a reorganização de arquivos, entre outras alterações que visam melhorar a qualidade do código. Ao utilizar o Conventional Commits, as mudanças de refatoração no código são facilmente identificáveis através da tag refactor.

  • 🧪 test

O tipo test é utilizado para indicar mudanças relacionadas a testes, seja a adição de novos testes, a atualização de testes existentes ou a remoção de testes obsoletos. Ao utilizar o Conventional Commits, as alterações relacionadas a testes são facilmente identificáveis através da tag test. Testes efetivos são fundamentais para garantir a qualidade do código e prevenir a introdução de bugs e erros em novas funcionalidades ou correções de bugs.

Lembrando que a adição de emojis é opcional, mas pode tornar as mensagens de commit mais visualmente atraentes e fáceis de entender.

Conclusão

Dominar a técnica dos Conventional Commits é um passo valioso para programadores iniciantes em Git. Essa abordagem não apenas melhora a clareza e organização do histórico de commits, mas também promove uma colaboração mais eficaz entre os membros da equipe.

Se você encontrou este artigo sobre Conventional Commits útil para sua jornada no desenvolvimento de software, ou se tem alguma pergunta ou sugestão, não hesite em compartilhar nos comentários abaixo.

Agradeço por dedicar seu tempo à leitura deste artigo e espero que ele tenha sido uma ferramenta útil na sua jornada de aprendizado em Git e desenvolvimento colaborativo.

Referências

Conventional Commits

Compartilhe
Comentários (2)

CT

Cleonice Targino - 24/08/2023 10:08

Parabéns pelo artigo, esse tipo de material é muito bom, ajuda muito!

Jorge Santos
Jorge Santos - 17/08/2023 13:47

Gostei, parabéns pelo artigo!