Guia prático: Padrão de Commit

Padrão de commit Seja trabalhando sozinho ou em um time com vários devs ora ou outra precisamos consultar commits anteriores. No começo eu acaba escrevendo meus commits como: "Correção”, “Melhorias” e  “Update”, pois não sabia que existia uma boa prática pra isso. Assim, sempre que precisava buscar alguma alteração antiga era muito difícil e confuso... Até que descobrir o Conventional Commits. 1. O que é Conventional Commits? Conventional commits trata-se de um padrão de escrita de mensagens de commit para facilitar a comunicação entre desenvolvedores e ajudar a manter o histórico do código organizado. O padrão é bem simples: (escopo): 2. Tipos Os tipos é obrigatório e são sobre o que se trata o commit. Só pode ser usado um por commit, caso esteja em dúvida sobre qual usar, provavelmente trata-se de uma grande mudança e é possível separar o código em dois ou mais commits. Os tipos mais comuns são: feat: novo recurso fix: solucionando um problema docs: mudanças na documentação test: alterações em testes build: alterações em arquivos de build e dependências perf: alterações relacionadas à performance style: formatação de código e lint refactor: refatoração de código que não altera a funcionalidade chore: atualizações de tarefas de build, configurações de administrador e pacotes cleanup: limpeza no código, legibilidade remove: exclusão de código/arquivos que não são mais utilizados revert: rollback para commit específico É possível adicionar um ! opcional na para chamar atenção a quebra de compatibilidade. Exemplo: feat!: descontinuar uso do componente card 3. Escopo Este é opcional e trata-se sobre qual é o escopo específico abordado, como um componente, fluxo ou configuração. 4. Descrição Para escrever a descrição podemos pensar: "se eu aplicar esse commit ele vai..." ou "O que essa alteração faz?" e completar a frase. Não é necessário colocar o porque do commit (motivação), mas sim o que de fato ele faz. É obrigatório escrever em inglês? Não, isso deve ser alinhado com outros devs que irão trabalhar no mesmo repositório, mas é sempre uma boa prática utilizar inglês para documentações. 5. Emojis É possível utilizar um emoji no início da mensagem de commit representando sobre o que ele se trata. É opicional e tem objetivo apenas visual para organização. Os principais tipos são: Tipo de commit Emojis Commit inicial

Mar 26, 2025 - 02:31
 0
Guia prático: Padrão de Commit

Padrão de commit

Seja trabalhando sozinho ou em um time com vários devs ora ou outra precisamos consultar commits anteriores. No começo eu acaba escrevendo meus commits como: "Correção”, “Melhorias” e  “Update”, pois não sabia que existia uma boa prática pra isso. Assim, sempre que precisava buscar alguma alteração antiga era muito difícil e confuso... Até que descobrir o Conventional Commits.

1. O que é Conventional Commits?

Conventional commits trata-se de um padrão de escrita de mensagens de commit para facilitar a comunicação entre desenvolvedores e ajudar a manter o histórico do código organizado.

O padrão é bem simples:
(escopo):

2. Tipos

Os tipos é obrigatório e são sobre o que se trata o commit.
Só pode ser usado um por commit, caso esteja em dúvida sobre qual usar, provavelmente trata-se de uma grande mudança e é possível separar o código em dois ou mais commits.

Os tipos mais comuns são:

  • feat: novo recurso
  • fix: solucionando um problema
  • docs: mudanças na documentação
  • test: alterações em testes
  • build: alterações em arquivos de build e dependências
  • perf: alterações relacionadas à performance
  • style: formatação de código e lint
  • refactor: refatoração de código que não altera a funcionalidade
  • chore: atualizações de tarefas de build, configurações de administrador e pacotes
  • cleanup: limpeza no código, legibilidade
  • remove: exclusão de código/arquivos que não são mais utilizados
  • revert: rollback para commit específico

É possível adicionar um ! opcional na para chamar atenção a quebra de compatibilidade.
Exemplo:

feat!: descontinuar uso do componente card

3. Escopo

Este é opcional e trata-se sobre qual é o escopo específico abordado, como um componente, fluxo ou configuração.

4. Descrição

Para escrever a descrição podemos pensar: "se eu aplicar esse commit ele vai..." ou "O que essa alteração faz?" e completar a frase.

  • Não é necessário colocar o porque do commit (motivação), mas sim o que de fato ele faz.
  • É obrigatório escrever em inglês? Não, isso deve ser alinhado com outros devs que irão trabalhar no mesmo repositório, mas é sempre uma boa prática utilizar inglês para documentações.

5. Emojis

É possível utilizar um emoji no início da mensagem de commit representando sobre o que ele se trata.
É opicional e tem objetivo apenas visual para organização.

Os principais tipos são:

Tipo de commit Emojis
Commit inicial

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies.