Article image
Marco Soares
Marco Soares30/09/2024 13:37
Compartilhe

Como realizar um bom commit

  • #GitHub
  • #Git

No grande e cada dia mais expansivo mundo da tecnologia, aqueles que trabalham no desenvolvimento de softwares ou aplicações web, devem saber controlar e realizar manutenções precisas no versionamento de seus projetos. Uma das ferramentas mais utilizadas para esta função é sem dúvidas alguma o Git, nos ajudando a verificar versões, checar "pushs", retornar a estados anteriores do projeto, seja trabalhando em equipe, ou em projetos solos.

Mesmo com estas funcionalidades incríveis no entanto, commits confusos, ou feitos sem serem pensados com calma, podem tornar o que era para ser uma ferramenta de controle, em uma biblioteca caótica!

O que é um commit?

Commits são instruções que geram uma referência ao estado do código trabalhado em dito tempo. Utilizando-se de metadados, tais como nome do autor, mensagem de commit, dia e horário para facilitar a sua busca. Sendo utilizados para salvar a progressão constante do desenvolvimento, anunciando mudanças efetuadas no código e integrando partes externas com o branch principal do projeto.

Dicas essenciais para um bom commit

Direto e Focado:

Commits devem ser diretos e focados na mensagem que desejam transmitir, tal como avisar sobre a implementação de uma feature, evitando assim que um commit apenas tenha uma infinidade de features ou correções diferentes sendo adicionadas ao mesmo tempo. Isso torna o trabalho mais confuso e difícil de segmentar.

Deve possuir uma mensagem descritiva:

Através deste tipo de commit, é possível explicar para seus colegas, ou deixar documentado qual a função daquele commit e por que tal mudança fora realizada. Permitindo que você e seus colegas consigam entender perfeitamente o que ele faz, sem que sequer seja necessário abrir o código.

Deve seguir as boas práticas de utilização do Git:

As boas práticas possuem este nome por serem o padrão seguido para que se tenha ordem e organização nos meios de desenvolvimento. Isso irá tornar seu histórico Git limpo, organizado e fácil de ler. Implementando o formato de tipo nos commits tais como correção, tarefa, refatoração, etc..., torna o commit ainda mais organizado e menos trabalhoso de se catalogar através destas referências.

Testado, analisado e aprovado:

Por último, mas não menos importante, antes de um commit é importante ter certeza de que ele está funcionando perfeitamente, que não está havendo conflito em sua implementação, afinal um commit de um código disruptivo pode acabar colocando todo um projeto em pause, até que o mesmo seja encontrado. Mantendo estas dicas em mente, com commits diretos, focados em um objetivo apenas, os condensando em um commit direto e preciso, você se tornará um profissional mais organizado, eficiente e com uma biblioteca exemplar!

Compartilhe
Comentários (1)
Kayllane Pina
Kayllane Pina - 30/09/2024 13:48

Ótimo artigo, Marco. Eu gosto de seguir um padrão de commit e inclusive eu uso esse repositório: iuricode/padroes-de-commits: Padrões de commits (github.com) como um guia para os meus commits