Boas práticas para o Git


Nome de branches

O nome da branch deverá ser apenas o ID da task no Devops. Por exemplo:

  • Task 4400 [BE] Realizar análise de código em loterias terá o nome de branch 4400

Esse padrão deverá ser respeitado por todas as branches que passarão por Code Review, branches para testes, normalização ou outros objetivos podem ter nomes diferentes.

Criação de PRs

Todas as PRs criadas devem ter o label para o ambiente que o código será enviado.
O título da PR deve ser o ID da task + uma breve descricão. Por exemplo:

As PRs para preprod e master deverão ter uma descrição contextuando o que foi feito e como foi feito, se baseando no template padrão de criação de PR.

Tasks com devs trabalhando em paralelo

Algumas tasks serão feitas por devs diferentes, um cuidando de front-end e outro de back-end. Nesses casos, os devs responsáveis pela task deverão acordar entre si a ordem de quem fará o trabalho primeiro, ou se trabalharão em paralelo. Será enviado para master e preprod apenas uma branch, que deverá conter todo o código e seguir o padrão de nomenclatura definido em Nome de branches.

Commits

Descreva sempre o que foi feito e onde foi feito em português, o objetivo dos commits é manter um histórico legível do que foi alterado no nosso código.

Como commitar:

  • adicionado template da mega sena no plugin de loterias
  • plugin loterias: adicionado template de mega sena
  • tema master – corrigido erro no filtro the_content na single
  • corrigido erro no filtro the_content na single do tema master

Como não commitar:

  • fix
  • debug
  • correção conflito
  • adicionado template
  • corrige filtro