Skip to content

Instantly share code, notes, and snippets.

@RudyJ
Forked from jorgehclinhares/commits-model.md
Created September 6, 2018 18:42
Show Gist options
  • Save RudyJ/f77a46a45d0370d374a406bb22b4dba9 to your computer and use it in GitHub Desktop.
Save RudyJ/f77a46a45d0370d374a406bb22b4dba9 to your computer and use it in GitHub Desktop.
Modelo de mensagem dos commits

Modelo de mensagem dos commits

by: @angular tradução: @pnasc

Cada mensagem de commit consistem em um cabeçalho, um corpo e um rodapé. O cabeçalho tem um formato especial que inclui um tipo, um escopo e título.

<tipo>(<escopo>): <título>
<LINHA EM BRANCO>
<corpo>
<LINHA EM BRANCO>
<rodapé>

O cabeçalho é obrigatório e o escopo é opcional.

Revertendo um commit

O commit deve começar com revert: caso ele reverta um commit anterior, com o cabeçalho do commit revertido. No corpo deve conter Reverte o commit <hash>, onde hash é o SHA do commit que está sendo revertido.

Tipos

Os tipos devem ser:

  • feat: Uma nova feature
  • fix: Uma correção de bugs
  • docs: Modificações nas documentações
  • style: Modificações que não alteram o significado do código (espaço em branco, formatação, ponto e virgula, etc)
  • refactor: Modificações que código que não são correção de bugs e nem adição de novas features
  • perf: Modificações no código que melhoram a performance
  • test: Inclusão de testes
  • chore: Modificações nos processos auxiliares e ferramentas como geração de documentação
  • delete: Remoção de arquivos não mais necessários

Escopo

O escopo pode ser tudo que especifique onde ocorreu a mudança no commit.

Título

O título deve conter uma breve descrição da mudança.

  • Use o imperativo no presente do indicativo, "mudança" não "mudou", nem "mudanças"
  • Não coloque a primeira letra em maiúsculo
  • Não coloque ponto final (.) no fim do título
  • Tente não passar dos 70 caracteres por título

Corpo

O corpo deve conter a motivação para a mudança em contraste com o comportamento anterior.

  • Use o imperativo no presente do indicativo, "mudança" não "mudou", nem "mudanças".
  • Quebre a linha aos 80 caracteres.

Rodapé

O rodapé deve conter referencias as issues que o commit fecha.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment