Executando verificação de segurança...
1

Qual a melhor maneira de escrever um pull request / merge request ?

No meu emprego atual, não temos um padrão de merge request, então cada um acaba fazendo do jeito que bem entender, então eu tento deixar os meus merges requets os mais claros e com alguns detalhes, caso seja pertinente.

Como usamos o azure (não integrado com GITLABS) para criar e definir as tarefas, seja elas bugs ou desenvolvimento de features, eu sempre coloco o ID da tarefa no titulo do meu MR seguido de algum titulo, algo como:

#00000 - Implementação do crud de tarefa

E na descrição do merge request eu destaco em topicos o que eu fiz, algo como:

Nesse commit foi feito:

  • Implementação do endpoint para criar uma tarefa;
  • Validação de duplicidade

O que vocês acham dessa abordagem? é boa, clara e objetiva?

Como vocês fazem? conhecem outra maneira?

Carregando publicação patrocinada...
1

Atualmente trabalho em uma empresa bem organizada nessa etapa.
No geral os commits são divididos entre FIX(correção) ou FEAT(novas features), então a estrutura fica feat/frase_da_atividade
No corpo do MR é dividido em:
Contexto (como o tema surgiu e conhecimentos que possam agregar no entendimento),
Problema (qual problema de negócio ou técnico está sendo resolvido),
Solução (o que está sendo proposto)
e Resultado.
Isso faz com que todo mundo que leia o MR entenda o porquê de ele estar sendo feito e como.
Caso ele fique muito extenso no geral é feita uma documentação mais detalhada desses pontos e adicionado ao MR.