Você quer usar o GitHub Copilot para revisar seu código e obter sugestões de melhoria. O GitHub Copilot pode analisar seu código em busca de problemas comuns, sugerir correções e propor padrões melhores. Este artigo explica como ativar a revisão de código do Copilot, configurá-la para seu repositório e interpretar as sugestões geradas.
A revisão de código do GitHub Copilot funciona executando um modelo de IA separado em pull requests. Ele verifica bugs, vulnerabilidades de segurança, problemas de estilo de código e questões de desempenho. O recurso está disponível para repositórios públicos sem custo adicional e para repositórios privados com uma licença Copilot Business ou Enterprise.
Este guia aborda as etapas de configuração, os tipos de sugestões que você pode esperar e o que fazer quando o Copilot não detecta um problema ou dá uma recomendação incorreta. Ao final, você saberá como integrar a revisão de código do Copilot ao fluxo de trabalho de pull requests da sua equipe.
Principais Conclusões: Usando o GitHub Copilot para Revisão de Código
- Configurações do repositório > Segurança e análise de código > Revisão de código do GitHub Copilot: Ative o recurso por repositório para começar a receber sugestões de IA em pull requests.
- Aba Arquivos alterados do pull request > Ícone de comentário de revisão: Veja sugestões individuais inline e aceite ou descarte diretamente no diff do código.
- Arquivo de configuração da revisão de código do Copilot (.github/copilot-review.yml): Personalize quais verificações são executadas, como segurança, desempenho ou regras de estilo, para alinhar aos padrões da sua equipe.
Como Funciona a Revisão de Código do GitHub Copilot
A revisão de código do GitHub Copilot é um recurso que adiciona um revisor com IA aos seus pull requests. Quando você abre um novo pull request, o Copilot analisa as alterações de código e publica comentários com sugestões. Essas sugestões cobrem problemas como falta de verificações de nulo, chamadas de API inseguras, lógica excessivamente complexa e desvios de padrões comuns de codificação.
O recurso usa um modelo separado do modelo de conclusão de código inline. Ele é treinado em um grande conjunto de revisões de código públicas e correções de bugs. A revisão de código do Copilot não modifica seu código. Ela apenas adiciona comentários de revisão que você pode aceitar, descartar ou ignorar.
Pré-requisitos
Antes de usar a revisão de código do Copilot, você precisa do seguinte:
- Uma conta do GitHub com uma assinatura do Copilot. Para repositórios privados, você precisa do Copilot Business ou Copilot Enterprise.
- Permissões de administrador ou proprietário do repositório para ativar o recurso nas configurações do repositório.
- Uma licença ativa do Copilot atribuída ao seu usuário do GitHub.
Idiomas Suportados
A revisão de código do Copilot suporta os mesmos idiomas que a conclusão de código do Copilot. Isso inclui Python, JavaScript, TypeScript, Java, C#, Go, Ruby, Rust e muitos outros. A qualidade das sugestões é maior para idiomas com grandes conjuntos de dados de treinamento.
Passos para Ativar e Usar a Revisão de Código do GitHub Copilot
Siga estes passos para ativar a revisão de código do Copilot em um repositório e usá-la durante a revisão de um pull request.
- Ative a revisão de código do Copilot no repositório
Acesse seu repositório no GitHub. Clique em Settings na barra de navegação superior. Na barra lateral esquerda, clique em Code security and analysis. Role para baixo até a seção GitHub Copilot code review. Clique no botão Enable ao lado de Copilot code review. O recurso agora está ativo para este repositório. - Crie ou abra um pull request
Abra um novo pull request no repositório. A revisão de código do Copilot é executada automaticamente quando o pull request é aberto. Ela também é executada quando você envia novos commits para um pull request existente. A revisão geralmente é concluída entre 30 segundos e dois minutos. - Revise as sugestões do Copilot no pull request
Vá para a página do pull request. Clique na aba Files changed. Você verá comentários de github-copilot inline no diff do código. Cada comentário destaca uma linha ou bloco específico e inclui uma sugestão. Leia a sugestão e decida se deseja aplicar a alteração. - Aceite ou descarte uma sugestão
Para aceitar uma sugestão, clique no botão Apply suggestion que aparece no comentário. Isso faz o commit da alteração diretamente no branch do pull request. Para descartar uma sugestão, clique no pequeno ícone X no cabeçalho do comentário. Sugestões descartadas ficam ocultas da visualização, mas permanecem no histórico do pull request. - Veja o resumo de todas as sugestões do Copilot
Role até o final da aba Files changed. O Copilot publica um comentário de resumo que lista todas as sugestões agrupadas por categoria. As categorias incluem Risco de bug, Segurança, Desempenho e Estilo. Use este resumo para priorizar quais problemas corrigir primeiro.
Personalizando a Revisão de Código do Copilot com um Arquivo de Configuração
Você pode controlar quais tipos de verificações o Copilot executa adicionando um arquivo de configuração ao seu repositório.
- Crie o arquivo de configuração
Na raiz do seu repositório, crie um novo arquivo chamado copilot-review.yml dentro da pasta .github. O caminho completo é .github/copilot-review.yml. - Adicione categorias de regras para ativar ou desativar
Abra o arquivo em um editor de texto. Adicione a seguinte estrutura YAML:checks:
security: true
performance: true
style: false
bug_risk: true
Defina cada categoria como true para ativá-la ou false para desativá-la. Salve e faça o commit do arquivo no branch padrão. - Verifique se a configuração entra em vigor
Abra um novo pull request. O Copilot lê o arquivo de configuração do branch padrão. A revisão agora ignorará quaisquer categorias desativadas.
Problemas Comuns e Limitações da Revisão de Código do Copilot
O Copilot Não Publica Nenhuma Sugestão em um Pull Request
Se você não vir comentários do Copilot em um pull request, verifique o seguinte. Primeiro, confirme que o recurso está ativado nas configurações do repositório em Code security and analysis. Segundo, verifique se sua assinatura do Copilot está ativa. Para repositórios privados, você precisa do Copilot Business ou Enterprise. Terceiro, verifique se o pull request contém pelo menos 10 linhas de código alterado. O Copilot ignora alterações muito pequenas. Por fim, certifique-se de que o pull request não é um rascunho. O Copilot revisa apenas pull requests abertos.
O Copilot Sugere uma Alteração Incorreta ou Irrelevante
A revisão de código do Copilot é uma ferramenta de IA e pode produzir falsos positivos. Se uma sugestão estiver errada, descarte-a usando o ícone X. Não aplique alterações cegamente. Sempre teste o código sugerido antes de mesclar. Para reduzir sugestões irrelevantes, desative a categoria style no arquivo de configuração se sua equipe usar um guia de estilo diferente.
O Copilot Não Detecta um Bug Conhecido no Código
O Copilot não substitui a revisão humana de código. Ele pode perder bugs específicos de contexto, erros de lógica de negócios ou problemas que exigem conhecimento de domínio. Sempre realize uma revisão manual junto com o Copilot. Use as sugestões do Copilot como um segundo par de olhos, não como a única barreira de qualidade.
Revisão de Código do GitHub Copilot vs Revisão Manual de Código
| Item | Revisão de Código do GitHub Copilot | Revisão Manual Humana |
|---|---|---|
| Velocidade | Conclui em segundos a minutos | Pode levar horas ou dias dependendo do tamanho da equipe |
| Cobertura | Verifica padrões comuns, segurança e estilo | Detecta lógica específica de domínio, problemas de arquitetura e convenções da equipe |
| Falsos positivos | Sugestões irrelevantes ou incorretas ocasionais | Baixo quando os revisores conhecem a base de código |
| Custo | Incluso na assinatura do Copilot | Usa tempo e salário do desenvolvedor |
| Curva de aprendizado | Configuração mínima necessária | Requer treinamento e experiência na base de código |
A revisão de código do Copilot funciona melhor como um complemento à revisão manual. Use-a para detectar problemas de baixo custo cedo, para que os revisores humanos possam se concentrar em questões de nível mais alto.
Agora você pode ativar a revisão de código do GitHub Copilot em seus repositórios e usar suas sugestões durante as revisões de pull requests. Comece ativando o recurso em um repositório e testando-o em alguns pull requests. Revise o comentário de resumo para ver as categorias de problemas que o Copilot detecta. Para controle avançado, crie um arquivo de configuração .github/copilot-review.yml para desativar verificações que não se encaixam no fluxo de trabalho da sua equipe. Lembre-se de que o Copilot é uma ferramenta para auxiliar, não substituir, o julgamento humano na revisão de código.