commits-semanticos

Commits semanticos by João

Commits semânticos são uma prática recomendada para manter um histórico de commits claro e informativo. Eles seguem uma convenção específica que descreve o tipo de mudança feita, o escopo (opcional) e uma descrição breve e concisa..

➡️ Conventional Commits

<tipo>(<escopo opcional>): <descrição>
<mensagem detalhada opcional>
<informações adicionais, como referências a issues ou PRs>

➡️ Tipos de Commits

➡️ Exemplos

Feat: Adicionando nova funcionalidade

git commit -m "feat(auth): adicionar funcionalidade de recuperação de senha"

Fix: Corrigindo um bug

git commit -m "fix(api): corrigir erro de validação no endpoint de login"

Docs: Atualizando a documentação

git commit -m "docs(README): adicionar instruções de configuração do projeto"

Style: Ajustando formatação de código

git commit -m "style: corrigir formatação do código no arquivo main.js"

👀 Observe

Os commits semânticos geralmente são escritos no infinitivo por várias razões:

❌ Exemplos de Mau Uso

📝 Mensagem Detalhada e Informações Adicionais

git commit -m "feat(auth): adicionar funcionalidade de recuperação de senha

Adiciona a capacidade de os usuários solicitarem a recuperação de senha
através de um email de recuperação. Inclui validação no backend e envio
de emails.

🛠️ Ferramentas

Commitizen

Clique na imagem para acessar o repositório

npm install -g commitizen

git cz

Husky

Clique na imagem para acessar o repositório

"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}

🤓 Me acompanhe para mais

"Não quero perder a pequena família que me resta. Eu vou vencer, não importa o que aconteça! Eu vou sobreviver, não importa o que aconteça. Só aos vitoriosos é permitido viver" Mikasa Ackerman