Padronização dos commits no projeto.
Histórico de Versões
Data | Versão | Descrição | Autor |
---|---|---|---|
09/08/2021 | 0.1 | Criação da política de commits | Lameque Fernandes |
11/08/2021 | 0.2 | Alterações | Lameque Fernandes |
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:
-
quando adicionar nova funcionalidade
-
quando alguma alteração for feita
-
quando melhorias de formato/estrutura do código
-
quando melhorar o desempenho
- 🚱 quando resolver memory leaks
-
quando escrever documentação
-
quando consertar um problema
-
quando remover código ou arquivos
-
quando consertar problemas de Integração Contínua
-
quando adicionar testes
-
quando lidar com segurança
-
quando realizar o upgrade de dependências
-
quando realizar downgrade de dependências
Assunto:
- Deve possuir no máximo 50 caracteres
- Devem estar em letras minúsculas
Exemplo de commit:
git commit -m ":bulb:(#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: 09 de ago. de 2021.
Políticas de Commit. Disponível em: https://fga-eps-mds.github.io/2020.1-Grupo6/policies/commits/. Acesso em: 09 de ago. de 2021