Commit pattern - ESG-Project/documentation GitHub Wiki

Aqui estão as especificações para os commits seguindo o padrão de Commits Convencionais e incluindo o ID da issue e o nome do repositório no escopo:

Estrutura dos Commits

<tipo>(<escopo>): <descrição>
<linha em branco>
[corpo do commit]
<linha em branco>
[rodapé]

Tipos de Commits

  • feat: Uma nova funcionalidade.
  • fix: Correção de bugs.
  • docs: Mudanças na documentação.
  • style: Mudanças que não afetam o significado do código (espaços em branco, formatação, ponto e vírgula ausente, etc).
  • refactor: Uma mudança no código que não corrige um bug nem adiciona uma funcionalidade.
  • perf: Mudança de código que melhora o desempenho.
  • test: Adicionando testes ausentes ou corrigindo testes existentes.
  • build: Mudanças que afetam o sistema de build ou dependências externas (exemplos de escopos: gulp, broccoli, npm).
  • ci: Mudanças em arquivos e scripts de configuração de CI (exemplos de escopos: Travis, Circle, BrowserStack, SauceLabs).
  • chore: Outras mudanças que não modificam src ou arquivos de teste.
  • revert: Revertendo um commit anterior.

Escopo

O escopo deve incluir o ID da issue, no formato SUASSU-0.

Descrição

Uma breve descrição imperativa no presente do que foi feito.

Corpo do Commit (Opcional)

  • Pode detalhar o que foi feito e o motivo.
  • Pode incluir qualquer informação adicional que ajude a entender a mudança.

Rodapé (Opcional)

  • Pode incluir informações sobre quebra de mudanças, issues fechadas, etc.

Exemplo

Commit com Corpo e Rodapé

feat(SUASSU-01): adicionar funcionalidade de login

Esta alteração adiciona a funcionalidade de login ao sistema. O usuário pode fazer login usando suas credenciais.

BREAKING CHANGE: A estrutura da API de login foi alterada, exigindo mudanças na integração.

Closes SUASSU-01

Commit Simples

fix(SUASSU-02): corrigir erro no formulário de registro

Diretrizes

  1. Use frases imperativas no presente: "adicionar", "corrigir" (não "adicionando", "corrigido").
  2. Inclua o ID da issue e o nome do repositório no escopo: Ex.: (SUASSU-01).
  3. Mantenha a descrição breve e clara.
  4. Explique no corpo se a mudança for complexa.
  5. Use o rodapé para anotações importantes e fechar issues.

Seguindo essas especificações, seus commits ficarão organizados e fáceis de entender, além de permitir uma melhor rastreabilidade das mudanças.

⚠️ **GitHub.com Fallback** ⚠️