O que o GitHub Copilot adiciona ao processo de revisão
Análises de código e análises de pull request são essenciais para a qualidade, mas também podem ser demoradas e desiguais. Os desenvolvedores geralmente fazem malabarismos com vários idiomas, formatação inconsistente e diffs grandes enquanto tentam fornecer feedback atencioso. O GitHub Copilot ajuda a aliviar essa carga de trabalho atuando como revisor e assistente colaborativo. Ele deteta problemas comuns, rascunha comentários de revisão, resume pedidos de pull e até destaca riscos de segurança, dando aos revisores um ponto de partida claro. Com instruções de revisão personalizadas, você pode orientar o Copilot a observar os mesmos padrões que você, garantindo consistência entre equipes e repositórios.
Ao final desta unidade, você será capaz de:
- Identificar os principais recursos do Copilot em revisões de código.
- Explique como as PRUs desbloqueiam recursos avançados de revisão.
- Reconhecer diferentes maneiras como a revisão do Copilot complementa e ajuda os desenvolvedores.
Principais características do Copilot em revisões de código
O Copilot apresenta vários recursos projetados para agilizar as avaliações:
Resumos de RP: O Copilot pode elaborar automaticamente descrições de solicitação pull que incluem um resumo claro das alterações e uma lista de arquivos afetados. Isso garante que os revisores comecem com o contexto, não com achismos.
Correções de segurança: Com a revisão de código Copilot integrada ao GitHub Code Scanning, as vulnerabilidades são sinalizadas em todos os idiomas. Por exemplo, em JavaScript, o Copilot pode detetar entradas não higienizadas passadas para eval() e comentar:
"Eval() com a entrada do usuário pode levar à injeção de código. Substitua-o por um analisador seguro como JSON.parse()." Em seguida, oferece um patch em linha alinhado com as diretrizes de segurança do repositório.
Explicações linha a linha: os revisores podem destacar o código e pedir ao Copilot para explicar a funcionalidade, ajudando-os a entender o código desconhecido rapidamente.
Comentários de redação: O copiloto pode gerar comentários de revisão com base nas melhores práticas ou diretrizes da equipe, tornando o feedback claro e acionável.
Avaliações no seu IDE: Além de trabalhar diretamente no GitHub.com, o Copilot também pode revisar o código dentro do seu IDE. Isso permite que os desenvolvedores detetem e resolvam problemas antes de abrir uma solicitação pull, acelerando o processo e reduzindo o retrabalho.
Entenda como as PRUs desbloqueiam recursos avançados de revisão
As PRUs alimentam essas capacidades avançadas. Por exemplo, designar o Copilot como revisor de PR utiliza uma PRU cada vez que publica comentários. Quando combinadas com arquivos personalizados .github/copilot-instructions.md, as avaliações impulsionadas por PRU alinham-se com as regras da sua equipa, focadas em legibilidade, segurança ou estilo.
Exemplo:
Sem o Copilot, um RP pode incluir comentários vagos de um revisor como "Corrigir problema de segurança aqui". Com a ajuda do Copilot + PRUs, a revisão torna-se:
"O uso de exec() introduz uma vulnerabilidade de injeção de código." Considere substituí-lo por subprocess.run() para uma execução de comando mais segura. Aqui está um patch sugerido:"
E fornece a correção de código em linha.
Cinco maneiras diferentes de a revisão do Copilot ajudar os desenvolvedores
Em seguida, analisaremos como a revisão do Copilot pode ajudá-lo a trabalhar de forma mais inteligente com:
- Sugestões de revisão de código
- As revisões do Copilot em vários idiomas
- Formatando dados em solicitações Pull
- Redação eficaz de resumos de pull request
- Explicando e revisando o código
Usando sugestões do Copilot em revisões de código
Ao analisar um pedido de pull, pode-se identificar áreas que poderiam ser melhoradas, mas não ter tempo para elaborar o exemplo ideal ou extrair um trecho. O Copiloto do GitHub ajuda a preencher essa lacuna sem assumir o trabalho do autor. Dentro da visualização "Arquivos alterados" da solicitação pull, você pode destacar uma linha ou bloco de código e pedir ao Copilot para sugerir melhorias ou sinalizar possíveis problemas. Em seguida, o Copilot gera uma sugestão concreta e sensível ao contexto que você pode copiar para o comentário da avaliação, tornando o feedback mais claro e fácil para o autor agir.
Por exemplo, ao revisar um arquivo Ruby com lógica repetida, você pode destacar as linhas relevantes e perguntar:
"Sugira um refatore Ruby mais limpo para este código repetido."
O Copilot irá propor uma versão atualizada que segue as melhores práticas comuns do Ruby. Você pode colar a recomendação (ou partes dela) no comentário da avaliação, juntamente com a sua própria explicação. Isso mantém você focado na qualidade geral e no design, ao mesmo tempo em que dá ao autor feedback acionável e de alto valor, sem borrar a linha entre a revisão e a codificação em seu nome.
Revisão em vários idiomas
Quando você solicita uma revisão de código, o Copilot pode destacar automaticamente áreas que não seguem as práticas recomendadas ou as diretrizes da equipe
O Copilot gerará rapidamente melhorias que se alinham com as convenções do idioma, permitindo que você dê feedback de revisão mais forte e preciso, mesmo fora de sua principal área de especialização.
Formatando dados para solicitações pull
As solicitações pull são muito mais claras quando incluem contexto bem formatado, como métricas, capturas de tela ou resultados de teste. No entanto, as equipes muitas vezes esquecem de formatar esse conteúdo de forma consistente. O GitHub Copilot pode atuar como um segundo conjunto de olhos durante a revisão de código, sinalizando automaticamente tabelas mal formatadas em uma descrição de solicitação pull e propondo uma versão mais limpa que se alinhe com as diretrizes de estilo da sua empresa.
Exemplo: um desenvolvedor envia uma solicitação pull com a seguinte tabela de tempos de carregamento de página. É difícil de ler e não segue o guia de estilo Markdown da equipe:
| Execução de teste | TempoCarregamentoAnterior | TempoDeCarregamentoApós |
|---|---|---|
| 1.3 | 1.2 | |
| 1.2 | 1.1 | |
| 1.1 | 0.885 | |
| 1.3 | 1.3 | |
| 1.2 | 0.918 | |
| Average | 1.22 | 1.0806 |
Durante a revisão, o Copilot posta um comentário:
"Esta tabela não segue as diretrizes de Markdown do seu repositório. Aqui está uma versão limpa com base no guia de estilo da sua empresa."
E inclui uma versão corrigida pronta para colar na descrição do PR:
| Execução de teste | Tempo de carregamento antes (em segundos) | Tempo de carregamento após atualizações (segundos) |
|---|---|---|
| 1 | 1.3 | 1.2 |
| 2 | 1.2 | 1.1 |
| 3 | 1.1 | 0.885 |
| 4 | 1.3 | 1.3 |
| 5 | 1.2 | 0.918 |
| Média | 1.22 | 1.0806 |
O revisor pode aceitar a sugestão do Copilot com um clique, garantindo que o RP siga o estilo da empresa sem gastar tempo reformatando.
Isso mostra o Copilot atuando como um revisor automático (não como um agente de codificação): ele vê a tabela não formatada, aplica as diretrizes da empresa de .github/copilot-instructions.md e fornece uma versão corrigida diretamente.
Redigir resumos de pull request eficazes
Escrever descrições de RP é muitas vezes a última etapa do processo e pode parecer um obstáculo. O Copilot torna isso mais fácil. No editor de descrição de PR, você pode usar o ícone Copilot para gerar um resumo ou esboço. Mesmo que você faça edições, ter um ponto de partida bem estruturado economiza tempo e garante que os revisores tenham as informações de que precisam.
Explicando e revisando o código
Às vezes, você pode não estar familiarizado com o código em uma solicitação pull. Em vez de lutar com isso, podes pedir ao Copilot para explicar as alterações. O Copilot também pode executar uma revisão inicial dos seus próprios PRs antes de pedir feedback dos colegas de equipa. Isso ajuda a detetar problemas menores, valida as práticas recomendadas e dá mais confiança na qualidade do envio.
Agora você sabe do que o Copilot é capaz quando se trata de revisões de código. Em seguida, vamos ver como usar as revisões do Copilot diretamente no GitHub.com.