Skip to content

Instantly share code, notes, and snippets.

@GlauberF
Created January 26, 2024 12:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save GlauberF/15af30a852e557f12571750b93ede981 to your computer and use it in GitHub Desktop.
Save GlauberF/15af30a852e557f12571750b93ede981 to your computer and use it in GitHub Desktop.

Padronização de Commits

A padronização de commits não apenas aprimora a legibilidade e compreensão do código, mas também contribui para um ambiente de desenvolvimento mais colaborativo, eficiente e sustentável. Ao adotar práticas de commits consistentes, as equipes de desenvolvimento fortalecem a qualidade do código, facilitando a manutenção a longo prazo e a evolução do projeto. O commit, neste contexto, representa a documentação essencial das alterações realizadas no código.

Para manter um padrão, não é necessário que o processo seja manual; pode-se automatizar para simplificar. Neste exemplo, compartilho como configurei na minha antiga startup, especificamente na parte do frontend, um padrão de commit automatizado utilizando as seguintes ferramentas:

@commitlint/cli: Uma ferramenta que ajuda a garantir que as mensagens de commit atendam a um conjunto predefinido de regras, assegurando consistência e clareza.

commitizen: Uma biblioteca que facilita a criação de mensagens de commit seguindo um formato predefinido. Ela guia os desenvolvedores por meio de um prompt interativo, ajudando a gerar mensagens de commit padronizadas.

husky: Uma ferramenta que possibilita a execução de scripts antes de certos eventos do Git, como commits. Isso é útil para garantir que as mensagens de commit sigam as convenções definidas.

Ao integrar essas ferramentas ao processo de desenvolvimento, conseguimos automatizar e padronizar o registro de alterações no código, promovendo uma colaboração mais eficiente e uma manutenção simplificada. Essas práticas contribuem significativamente para a qualidade e sustentabilidade do projeto ao longo do tempo.

Gravacao.de.tela.de.26-01-2024.09_44_11.webm
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment