Ajudando outras pessoas a revisar suas alterações

Quando cria uma pull request, você está pedindo à sua equipe que revise suas alterações e forneça comentários. Este guia fornece as práticas recomendadas para criar pull requests fáceis de revisar e manter sua equipe informada, para que você possa melhorar a colaboração e a qualidade das revisões.

Facilitando a revisão de suas alterações

Um contexto claro nas pull requests ajuda os revisores a ver rapidamente o que você mudou e por que a alteração é importante. Isso torna o processo de revisão mais rápido e suave, com menos vai-e-vem, e ajuda a equipe a fazer melhores comentários e tomar decisões informadas. Para obter mais informações sobre a criação de pull requests, confira Como criar uma solicitação de pull.

Escrever pull requests pequenas

Procure criar pull requests pequenas, com foco, que atendam a um propósito único. Pull requests menores são mais fáceis e rápidas de revisar e mesclar, deixam menos espaço para bugs, além de fornecer um histórico mais claro das alterações.

Forneça contexto e orientação

Escreva títulos e descrições claras para suas pull requests, para que os revisores consigam entender rapidamente o propósito da solicitação. Inclua o seguinte no corpo da pull request:

• A finalidade da pull request
• Uma visão geral das alterações
• Links para algum contexto adicional, como problemas de acompanhamento ou conversas anteriores

Para ajudar os revisores, compartilhe o tipo de feedback necessário. Por exemplo, você precisa de uma conferida rápida ou de uma crítica mais profunda? Além disso, você pode usar o GitHub Copilot para gerar um resumo da pull request. Confira Usar o GitHub Copilot para gerar resumos de pull request, mais adiante neste artigo.

Se sua pull request consistir em alterações em vários arquivos, forneça orientação aos revisores sobre a ordem de revisão dos arquivos. Recomende por onde a revisão deve começar e como proceder.

Revise sua própria pull request primeiro

Revise, crie e teste sua própria pull request antes de enviá-la. Isso permitirá que você detecte erros gerais e de digitação que você pode ter deixado passar, antes que outros comecem a revisar.

Revisão de segurança

Há várias ferramentas disponíveis que podem ajudar você a revisar sua pull request quanto a possíveis problemas de segurança antes que outras pessoas a revisem. A revisão de segurança ajuda a capturar e resolver problemas de segurança antecipadamente e permite que você realce riscos não resolvidos para outras pessoas revisarem e aconselharem. Por exemplo, você pode:

• Verifique a comparação de dependências para ver se sua pull request está introduzindo dependências vulneráveis. Confira Revendo alterações de dependência em um pull request.
• Verifique o GitHub Advisory Database para localizar o contexto e informações adicionais sobre dependências vulneráveis.
• Investigue e resolva quaisquer verificações de segurança ou fluxos de trabalho com falha, como a ação de revisão de dependência ou a verificação de resultados da code scanning. Confira Sobre a análise de dependência e Alertas de varredura de código de triagem em pull requests.
• Se o repositório tiver configurado a code scanning como uma verificação de pull request, use o Correção automática do GitHub Copilot para sugerir correções para vulnerabilidades de segurança em seu código. Confira Alertas de varredura de código de triagem em pull requests.

Mantendo a equipe informada

Pull requests podem fazer mais do que apenas documentar alterações de código. Elas também são uma maneira poderosa de manter sua equipe e seu gerente informados sobre o status do trabalho. Ao deixar seu progresso visível em pull requests, você pode reduzir a necessidade de atualizações separadas e garantir que todos permaneçam alinhados.

Usar o GitHub Copilot para gerar resumos de pull request

Você pode usar o Copilot para gerar um resumo de uma pull request no GitHub. Use o resumo para ajudar os revisores a entender suas alterações.

1. Em GitHub, crie uma pull request ou navegue até uma existente.

   Observação

   O Copilot não leva em conta nenhum conteúdo existente na descrição da pull request; portanto, é melhor começar com uma descrição em branco.

2. Navegue até o campo de texto ao qual você deseja adicionar o resumo da solicitação de pull.

   • Se você estiver criando uma nova solicitação de pull, use o campo "Adicionar uma descrição".
   • Se você estiver adicionando uma descrição a uma solicitação de pull existente, edite o comentário de abertura.
   • Se você estiver adicionando um resumo como comentário, navegue até a seção "Adicionar um comentário" na parte inferior da página de solicitação de pull.

3. No cabeçalho do campo de texto, selecione e clique em Resumo.

   

4. Aguarde até que o Copilot gere o resumo e, em seguida, verifique os resultados cuidadosamente.

5. Adicione qualquer outro contexto que ajude as pessoas a visualizar sua solicitação de pull.

6. Quando estiver satisfeito com a descrição, clique em Criar solicitação de pull em uma nova solicitação de pull ou Atualizar comentário se estiver editando uma descrição existente.

Link para problemas ou projetos relacionados

Conecte sua pull request a problemas ou quadros de projeto relevantes para mostrar como seu trabalho se encaixa no projeto maior.

• Adicione palavras-chave como Closes ISSUE-LINK à descrição para vincular e fechar automaticamente o problema quando a pull request for mesclada.
• Use Projects para acompanhar seu trabalho e vincular ao projeto a partir de sua pull request, facilitando o acompanhamento de progresso em um só lugar. Confira Sobre Projects.

Realçar o status com rótulos

Adicione um rótulo de status à sua pull request para mostrar se ela está pronta para revisão, bloqueada ou em andamento. Isso ajuda os revisores a entender o estado do trabalho rapidamente. Para saber mais, confira Gerenciar etiquetas.