Política de Commits - estudeplus/docs GitHub Wiki
Sempre divida seu trabalho em commits pequenos e significativos de forma que cada commit implemente somente uma funcionalidade.
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.
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.
A anatomia do commit deve seguir o seguinte padrão:
Formato:
<tipo>(#número da issue): assunto
<corpo>
- 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
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 opor 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
- Git Commit Msg. Karma. Disponível em: http://karma-runner.github.io/3.0/dev/git-commit-msg.html. Acessado em: 4 de abril de 2019.