Skip to content

Template de Commit

Padronização dos commits no projeto.

Histórico de Versões

Data Versão Descrição Autor
14/02/2022 0.1 Criação da política de commits Matheus Pimentel

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:

Para inserir um emoji, basta digitar: ":nome_do_emoji:". Exemplo: ":bulb:"

Lista de emojis disponíveis em markdown

  • 🚀 quando adicionar código do front-end :rocket:
  • 💾 quando adicionar código do back-end :floppy_disk:
  • 🔁 quando alguma alteração for feita :repeat:
  • 🆒 quando melhorias de formato/estrutura do código :cool:
  • 🐎 quando melhorar o desempenho :racehorse:
  • ❌ quando resolver memory leaks :x:
  • 📝 quando escrever documentação :pencil:
  • 🐛 quando consertar um problema :bug:
  • 🔥 quando remover código ou arquivos :fire:
  • 💚 quando consertar problemas de Integração Contínua :green_heart:
  • ✅ quando adicionar testes :white_check_mark:
  • 🔒 quando lidar com segurança :lock:
  • ⬆ quando realizar o upgrade de dependências :arrow_up:
  • ⬇ quando realizar downgrade de dependências :arrow_down:

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

Políticas de Commit. Disponível em: https://github.com/fga-eps-mds/2021.1-AlligaBot/blob/main/docs/_posts/2021-08-18-commits.md. Acesso em: 14 de fev. de 2022

Back to top