Skip to content

Latest commit

 

History

History
118 lines (65 loc) · 2.86 KB

COMMIT_CAMPEAO.md

File metadata and controls

118 lines (65 loc) · 2.86 KB
Raw

Guia do Commit Amigão

- Ow, o que este commit "whatever" faz?
- Sei lá, abre o código aí.
- Assim não, fera...

Já passou por isso? Uma tremenda mancada, não? Pega uma cadeira e vamos conversar sobre como escrever aquela mensagem de Commit Amigável.

A premissa é simples: Sem padrão, o git log vira aquela feira da fruta.

Vamos melhorar isso levando em consideração os seguintes pontos:

  • A navegação simplificada pelo histórico de commits
  • Manter um padrão entre os desenvolvedores
  • Passar o contexto da mudança
  • Ajudar na mantenabilidade do projeto em longo prazo
  • Facilitar a geração de changelog

Como alcançar este log que jorra leite e mel?

O time há de concordar com uma convenção que siga os seguintes aspectos:

Estilo: sintaxe, gramática, capitalização, pontuação. Elabore essas coisas, remova o jogo de adivinhação e faça tudo o mais simples possível.

Conteúdo: que tipo de informação deveria conter no corpo da mensagem de commit? ou se não deveria conter

Metadata: como devemos rastrear as referencias das issues, por IDs, pull request ou o que deve ser utilizado como referencia?

Pois depois de tudo que foi dito acima você gostaria de ver um log assim:

ao invés de algo similar a isto

Anatomia do Commit Amigão

Já existem convenções bem estabelecidas. No nosso caso, usamos o petardo maravilhoso do Karma Commit Messages.

Formato Bonitão

<tipo>(escopo): assunto

<corpo>

<rodapé>

Assunto

  • Máximo de 50 caracteres
  • Tipo de escopo devem estar em letras minúsculas
  • Assunto deve estar no imperativo

Exemplo:

feat(bregumelo): adiciona endpoint /whatever/.

Os valores permitidos para o tipo são:

  • feat (nova funcionalidade)
  • style (formatação geral no código. Não confundir com CSS)
  • refactor (refatoração de código de produção)
  • test (adicionar/refatorar testes)
  • fix (adivinha qual é esse)
  • docs (e esse também)
  • chore (atualização de tarefas ou código que não está relacionado a produção)

Corpo

  • Deve conter o o que e o por que ao invês de conter o como foi feito
  • Máximo de 80 caracteres

Se é necessário contextualizar o commit, explicar o porquê das mudanças, fique a vonts!

Exemplo:

refactor(bregumelo): modifica a chamada do model

A chamada anterior sofreu alterações de contrato, logo, foi necessário
refatorá-la.

Rodapé

Basicamente, um indicador de metadados. Aqui você referencia quais issues estão relacionadas, qual issue este commit encerra e etc.

refactor(bregumelo): modifica a chamada do model

A chamada anterior sofreu alterações de contrato, logo, foi necessário
refatorá-la.

Closes #123

Links