Política de Commits - estudeplus/docs GitHub Wiki

Política de Commits

Princípios básicos

1 - Faça commits atômicos

Sempre divida seu trabalho em commits pequenos e significativos de forma que cada commit implemente somente uma funcionalidade.

2 - Sempre escreva as mensagens de seus commits em INGLÊS

Com o intuito de tornar o projeto mais acessível para contribuidores que não falem português, foi adotado que o idioma padrão para o código e tudo que for diretamente relacionado a ele(ex: commits, branches e comentários de codigo) deve ser o inglês, logo as mensagens de commits devem ser escritas em inglês.

3 - Siga a regra 50/72

As mensagens devem ser escritas em 50 caracteres, caso seja necessário escrever uma mensagem maior, escreva um resumo em 50 caracteres, adicione um linha em branco, e descreva melhor o commit em quantas linhas desejar, porém todas as linhas devem ter no máximo 72 caracteres. Caso não consiga descrever o seu commit com essa regra, o seu commit provavelmente não é atômico.

Anatomia do Commit

A anatomia do commit deve seguir o seguinte padrão:

Formato:

<tipo>(#número da issue): assunto

<corpo>

Assunto

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

Exemplo:

feat(#35): add route /login.

Os valores permitidos para o tipo são:

  • feat: nova funcionalidade
  • style: formatação geral no código
  • refact: refatoração de código
  • test: adicionar/refatorar testes
  • fix: correções
  • docs: relacionado a documentação

Corpo

Se é necessário contextualizar o commit e explicar o porquê das mudanças, descreva o corpo do commit de acordo com o seguinte:

  • Deve conter o o que e o por que foi feito
  • Máximo de 80 caracteres

Exemplo:

refactor(#25): change login method to oauth 

The previous login method was insecure due a new exploit discovered

Referências

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