Fazer commits de forma semântica melhora a organização do projeto.
O seguinte formato pode ser utilizado:
<tipo>(<escopo>): <mensagem do commit>
<escopo>
é opcional. Alguns exemplo de escopo: api, config, init, etc.
git commit -m "feat(api): enviar um e-mail ao cliente quando a obra for atualizada."
| | |
| | +----> resumo do commit
| +-------------> escopo
+-----------------> tipo: feat, fix, docs, style, refactor, test, chore
feat
: novo recurso no sistema. Exemplo: adicionar um novo endpoint em uma APIfix
: correção de um bugdocs
: mudanças na documentaçãostyle
: formatação/estilo de código, adição de ponto e vírgularefactor
: refatoração do código. Visando melhorando a organização, deixando o código mais limpo, reutilizável, eficiente. E que pode mudar a estrutura geral. Em resumo, alterações para reorganizar o código para melhorar sua estrutura.test
: adição ou refatoração de testeschore
: alterações que não influenciam o sistema ou os testes. Exemplo: Adicionar algo no .gitignorecleanup
: Remoção de espaços, comentários e variáveis não utilizadasremove
: remover código desnecessário sem mudar a estrutura geral