Ao criar uma solicitação de pull, você está solicitando que outras pessoas examinem suas alterações e forneçam comentários. Pull requests focados, claros e fáceis de analisar ajudam os revisores a fornecer feedback melhor e a fazer sugestões com confiança.
Facilitando a revisão de suas alterações
O contexto claro ajuda os revisores a entender rapidamente o que mudou e por que isso importa. Ele reduz o vai-e-vem, torna a revisão mais rápida e ajuda sua equipe a se concentrar nas partes mais importantes da mudança.
Escrever pull requests pequenas
Solicitações de pull pequenas e focadas são mais fáceis de examinar e mais seguras de mesclar. Eles ajudam os revisores a entender a finalidade da alteração, detectar problemas mais rapidamente e seguir o histórico do projeto mais tarde.
Quando uma alteração ficar muito grande, considere dividi-la em pull requests menores, cada um com um único propósito.
Forneça contexto e orientação
Um título claro e uma descrição ajudam os revisores a entender o problema, a abordagem e o resultado. Um bom contexto geralmente explica por que a mudança é necessária, o que mudou e onde os revisores devem prestar atenção especial.
As orientações são especialmente úteis quando um pull request envolve muitos arquivos ou exige uma ordem de revisão específica. Por exemplo, você pode apontar os revisores para os arquivos mais importantes primeiro ou explicar qual tipo de comentário seria mais útil. Você também pode usar GitHub Copilot para gerar um resumo da solicitação de pull.
Revise sua própria pull request primeiro
Revisar sua própria solicitação de pull antes de pedir a outras pessoas para revisá-la ajuda você a detectar erros mais cedo. Ele também mostra aos revisores que a solicitação de pull está pronta para sua atenção.
Uma autorevisão pode incluir revisar o diff, verificar se houve alterações acidentais e garantir que as compilações ou os testes relevantes tenham sido executados.
Revisão de segurança
As revisões de segurança ajudam a capturar o risco antes que uma solicitação de pull seja mesclada. Isso é especialmente importante quando uma solicitação de pull altera dependências, autenticação, permissões, fluxos de trabalho ou código que manipula dados confidenciais.
GitHub pode exibir informações de segurança em pull requests, como alterações de dependências, resultados da revisão de dependências e verificações do code scanning. Use esses sinais para resolver problemas mais cedo ou para realçar riscos que precisam de atenção do revisor.
Se code scanning estiver configurado como uma verificação no seu repositório, Correção Automática do GitHub Copilot pode sugerir correções para vulnerabilidades de segurança.
Mantendo a equipe informada
As solicitações de pull podem fazer mais do que as alterações de código do documento. Elas também são uma maneira de manter sua equipe informada sobre o status do seu trabalho. O progresso visível ajuda a reduzir atualizações de status separadas e mantém todos alinhados.
Usar GitHub Copilot para gerar resumos de solicitação de pull
Observação
Copilot os recursos exigem um Copilot plano. Consulte Planos para GitHub Copilot.
Copilot pode gerar um resumo da solicitação de pull em GitHub. Um resumo gerado pode ajudar os revisores a entender as principais alterações, mas você deve revisá-la com cuidado e adicionar contexto que só você conhece.
Os resumos são mais úteis quando explicam o objetivo da alteração, destacam os arquivos importantes e ressaltam qualquer ponto que os revisores devam examinar com atenção.
Link para problemas ou projetos relacionados
Conectar uma solicitação pull a problemas ou projetos mostra como o trabalho se encaixa no projeto maior. Os links ajudam os revisores a entender a prioridade, acompanhar o progresso e encontrar discussões relacionadas.
Use palavras-chave de fechamento de problemas quando uma solicitação de pull deve fechar um problema após a mesclagem. Você também pode adicionar um link para Projects para que as pessoas possam acompanhar o trabalho em um único lugar.
Destacar o status com rótulos
Os rótulos de status ajudam os revisores a entender se uma solicitação de pull está pronta para revisão, bloqueada ou ainda em andamento. Os rótulos claros facilitam que as pessoas priorizem as revisões e evitem revisar o trabalho antes que ele esteja pronto.