Skip to content

🛠️ como criar um pull request

Jump to bottom
Leticia Campos edited this page Apr 11, 2025 · 1 revision

📋 Objetivo

Este guia foi desenvolvido para padronizar a criação de Pull Requests no repositório e garantir que as informações necessárias sejam registradas corretamente. Isso ajuda a manter o controle sobre o desenvolvimento, facilita revisões e garante a rastreabilidade de cada mudança.

📝 Passos para Criar um Pull Request

1. Responder ao Template de Feature

Ao criar o PR, preencha o questionário presente no template da Feature. Certifique-se de responder a todos os pontos:

  • Qual é a funcionalidade/melhoria proposta?
  • Quais são os impactos esperados no sistema?
  • Como testar esta funcionalidade após o merge?

O template será carregado automaticamente ao iniciar o PR.

2. Incluir as Informações Obrigatórias

Certifique-se de adicionar as informações abaixo no corpo do Pull Request ou nos campos específicos:

Item Descrição
Número da História Inclua o número da história ou tarefa vinculada (Ex.: HIST-123).
Número da Issue Vincule o número da issue relacionada no GitHub (Ex.: #456).
Label do Ambiente Adicione uma label correspondente ao ambiente (Ex.: Produção, Teste, Dev).
Projeto Vincule o Pull Request ao projeto relevante no GitHub (Ex.: Projeto Backend).
Status de Andamento Defina o status atual (Ex.: Em Desenvolvimento, Pronto para Review).
Data e Número da GMUD Inclua a data e o número da GMUD associada à mudança (Ex.: GMUD-789 - 10/04/25).

3. Adicionar Labels e Configurações

  1. Labels:
    • Escolha labels apropriadas para o PR (Ex.: Bugfix, Enhancement, DevOps).
  2. Vincular ao Projeto:
    • Use a seção Linked Project para vincular o PR ao projeto GitHub correspondente.
  3. Associar ao Issue Tracker:
    • No menu lateral, vincule o Pull Request à issue relacionada.

4. Checklist Final

Antes de abrir o PR, revise o checklist abaixo:

  • Respondi ao questionário do template de Feature.
  • Vinculei o número da história e issue no PR.
  • Adicionei labels apropriadas ao ambiente e ao tipo de mudança.
  • Vinculei o PR ao projeto e ao status atual.
  • Registrei a data e o número da GMUD no corpo do PR.

Exemplo de Pull Request

Título: [Feature] Implementação de Nova API de Relatórios

Descrição: Implementação da nova API de relatórios conforme história HIST-123. Este PR resolve a issue #456 e adiciona integração ao ambiente de Produção.

Informações:

  • História: HIST-123
  • Issue: #456
  • Label: Produção
  • Projeto: Projeto Backend
  • Status: Pronto para Review
  • Data da GMUD: 10/04/2025
  • Número da GMUD: GMUD-789

Checklist:

  • Respondi ao template de Feature.
  • Vinculei a história e a issue relacionadas.
  • Adicionei labels do ambiente.
  • Vinculei ao projeto e ao status atual.
  • Registrei a GMUD.

📖 Notas Importantes

  • Certifique-se de que todas as informações estejam atualizadas antes do review.
  • Utilize o modelo padrão do template para manter consistência.
  • PRs sem as informações obrigatórias podem ser rejeitados ou requisitar revisão.

calendário de implantações

⚡ página inicial

🗓️ meses - histórico de implantações

📊 relatórios e métricas

🛠️ tutoriais e suporte

Clone this wiki locally