Padrões para Merge Request (MR)

Padrões e Sugestões para Títulos e Descrições de Merge Requests

Ao criar um Merge Request (MR) dentro do fluxo git-flow, é crucial seguir padrões e fornecer informações claras para facilitar a revisão e aprovação do código. Aqui estão algumas sugestões:

Título do Merge Request:

O título deve ser conciso e informativo, fornecendo uma visão geral da alteração realizada. Sugestões de padrões incluem:

• [Número da Issue] - Descrição Concisa da Tarefa Exemplo: #542 - Implementação da Feature XYZ

• [Tipo de Alteração] - Descrição da Alteração Exemplo: Feature: Adiciona Autenticação de Usuário

Descrição do Merge Request:

A descrição é uma oportunidade para fornecer detalhes adicionais sobre a alteração. Inclua informações como:

1. Contexto da Alteração: Explique por que essa alteração é necessária. Se relaciona a uma issue específica, mencione-a.

2. Lista de Mudanças: Enumere as principais alterações realizadas. Isso ajuda os revisores a entenderem as diferenças no código.

3. Testes Realizados: Descreva os testes que foram realizados para garantir a integridade da alteração.

4. Screenshots (se aplicável): Inclua capturas de tela antes e depois, se a alteração afetar a interface do usuário.

5. Referências: Adicione links para documentação relevante, discussões ou referências que possam auxiliar na compreensão da alteração.

Exemplo Prático:

Título do Merge Request:

#542 - Adiciona Funcionalidade de Pesquisa de Usuário

Descrição do Merge Request:

1. Contexto da Alteração: Esta alteração atende à Issue #542, que solicitou a implementação de uma barra de pesquisa para facilitar a localização de usuários no sistema.

2. Lista de Mudanças:

   • Adição de barra de pesquisa na barra de navegação.
   • Atualização da lógica de busca no backend.

3. Testes Realizados:

   • Testes de unidade para a nova funcionalidade.
   • Testes de integração para garantir compatibilidade com outras partes do sistema.

4. Screenshots:

   • Screenshot da nova barra de pesquisa.

5. Referências:

   • Documentação da Issue #542.

Ao seguir essas sugestões, torna-se mais fácil para os revisores entenderem e avaliarem a proposta de alteração apresentada no Merge Request.