Este documento descreve o padrão de commit que estamos seguindo neste projeto. O objetivo é manter a consistência e a clareza no histórico de commits.
Cada commit deve seguir este formato:
{tipo do que foi feito}:{Front ou Back}: {Resumo do que foi feito}
- Tipo do que foi feito: Esta é uma breve descrição do tipo de alteração que foi feita. Exemplos incluem
featpara novas funcionalidades,fixpara correções de bugs,docspara alterações na documentação, etc. - Front ou Back: Indica se a alteração foi feita no frontend ou no backend.
- Resumo do que foi feito: Uma breve descrição do que foi alterado ou adicionado.
A descrição do commit deve detalhar o que foi feito. Isso é especialmente útil quando a alteração é complexa ou não é imediatamente óbvia a partir do resumo do commit.
{Detalhes do que foi feito}
A descrição do commit deve ser escrita em linguagem clara e compreensível, e deve explicar o 'o quê' e 'por que' da alteração, em vez do 'como'.
Aqui está um exemplo de como um commit pode parecer:
feat:Front: Adicionado botão de login
Um novo botão de login foi adicionado na página inicial. Isso foi feito para melhorar a experiência do usuário e permitir que os usuários façam login de forma mais eficiente.
Esperamos que todos sigam este padrão para manter um histórico de commit limpo e compreensível.