Politica de Commits
Padronização dos commits no projeto.
Histórico de Versões
Data | Versão | Descrição | Autor |
---|---|---|---|
15/02/2022 | 1.0 | Criação da política de commits | Fellipe Pereira da Costa Silva |
15/02/2022 | 2.0 | Correção nas referências | Fellipe Pereira da Costa Silva |
Semântica do Commit
Os commits devem seguir o seguinte padrão:
Princípios:
Commits atômicos
Sempre dividir em pequenos e significativos commits, fazendo com que cada commit tenha apenas uma funcionalidade.
Commits em português
Por ser um projeto voltado totalmente para um público brasileiro e por toda equipe ter mais afinidade com o português, foi decidido que todos os commits serão em pt-BR.
Formato:
<tipo>(#número da issue): assunto
Tipos:
feat
: nova funcionalidaderefact
: refatoração de códigotest
: adicionar/refatorar testesfix
: correçõesdocs
: relacionado a documentação
Assunto:
- Deve possuir no máximo 50 caracteres
- Devem estar em letras minúsculas
Exemplo de commit:
git commit -m "feat(#02): botão na página inicial"
Referências
DARTORA, João. Tudo o que você precisa saber sobre commits semânticos. Ilegra. Disponível em: https://ilegra.com/blog/tudo-o-que-voce-precisa-saber-sobre-commits-semanticos/. Acesso em: 15 de fev. de 2022.
Políticas de Commit. Disponível em: https://github.com/fga-eps-mds/2021.1-AlligaBot/edit/main/docs/. Acesso em: 14 de fev. de 2022.