Skip to main content

Como usar a revisão de código do GitHub Copilot

Saiba como solicitar uma revisão de código no GitHub Copilot.

Note

Sobre a Revisão de código do Copilot

O GitHub Copilot pode revisar seu código e fornecer comentários. Sempre que possível, os comentários do Copilot incluem sugestões de alterações que você pode aplicar com alguns cliques.

A Revisão de código do Copilot dá suporte a dois tipos de revisão:

  • Revisar a seleção: realce o código e peça uma revisão inicial (somente Visual Studio Code)
  • Revisar as alterações: solicite uma revisão mais detalhada de todas as alterações (site do GitHub e Visual Studio Code)

A funcionalidade e a disponibilidade atuais dos dois tipos de revisão são resumidas na seguinte tabela:

RecursoRevisar a seleçãoAnalisar revisão
AmbienteVisual Studio CodeVisual Studio Code e o site do GitHub
DescriçãoRevisão inicial de uma seção realçada do código com comentários e sugestõesRevisão mais detalhada de todas as alterações
Suporte ao idiomaTudoC#, Go, Java, JavaScript, Markdown, Python, Ruby e TypeScript
Suporte a diretrizes de codificação personalizadasNãoSim, confira Como personalizar as revisões do Copilot com diretrizes de codificação
DisponibilidadeVersão prévia pública, disponível para todos os assinantes do CopilotVersão prévia pública com lista de espera. Confira “Entrar na lista de espera da Revisão de código do Copilot

Warning

Não há nenhuma garantia de que o Copilot detectará todos os problemas de uma pull request e, às vezes, ele cometerá erros. Sempre valide os comentários do Copilot com atenção e complemente os comentários do Copilot com uma revisão humana.

Para obter mais informações, confira "Uso responsável da revisão de código do GitHub Copilot".

Como solicitar uma revisão do Copilot

Estas instruções explicam como usar a Revisão de código do Copilot no site do GitHub. Para ver as instruções para o Visual Studio Code, use o seletor de ferramentas “Visual Studio Code” na parte superior da página.

Como solicitar uma revisão da solicitação de pull request do Copilot

Note

Atualmente, a solicitação de uma revisão da solicitação de pull request do Copilot só está disponível para um número limitado de assinantes do Copilot. Para entrar na lista de espera, confira “Entrar na lista de espera da Revisão de código do Copilot”.

  1. Em GitHub.com, crie uma solicitação de pull ou navegue até uma existente.

  2. Abra o menu Revisores e escolha Copilot.

    Captura de tela da seleção de ‘Copilot’ no menu ‘Revisores’.

  3. Aguarde o Copilot revisar sua pull request. Normalmente, isso leva menos de 30 segundos.

  4. Role a página para baixo e leia os comentários do Copilot.

    Captura de tela de uma revisão de código deixada pelo Copilot.

    O Copilot sempre deixa uma revisão “Comentário”, não uma revisão “Aprovar” nem “Solicitar alterações”. Isso significa que as revisões do Copilot não contam para as revisões necessárias para a pull request e as revisões do Copilot não bloquearão o merge de alterações. Para saber mais, confira "Aprovar uma pull request com revisões obrigatórias".

  5. Os comentários da revisão do Copilot são parecidos com os comentários de revisão feitos por humanos. Você pode adicionar reações a eles, comentá-los, resolvê-los e ocultá-los.

    Qualquer comentário que você adicionar aos comentários da revisão do Copilot ficará visível para humanos, mas não para o Copilot, e o Copilot não responderá a ele.

Como trabalhar com as sugestões de alterações fornecidas pelo Copilot

Sempre que possível, os comentários do Copilot incluem sugestões de alterações que você pode aplicar com alguns cliques.

Se você estiver satisfeito com as alterações, poderá aceitar uma só sugestão do Copilot e fazer commit dela ou aceitar um grupo de sugestões juntas em um só commit. Para obter mais informações, confira "Incorporando feedback em sua pull request".

Caso deseje validar as sugestões de alterações do Copilot (por exemplo, executando testes automatizados ou o seu linter) ou fazer modificações antes de fazer commit delas, selecione o botão Abrir no Workspace. Para obter mais informações, confira "Como usar o Copilot para facilitar seu trabalho em uma pull request".

Como fornecer comentários sobre as revisões do Copilot

Você pode fornecer comentários sobre os comentários do Copilot diretamente em cada comentário. Usamos essas informações para aprimorar o produto e a qualidade das sugestões do Copilot.

  1. Em um comentário de uma revisão da solicitação de pull request do Copilot, selecione o botão de polegar para cima (👍) ou de polegar para baixo (👎).

    Captura de tela que mostra um comentário da Revisão de código do Copilot com os botões de polegar para cima e para baixo.

  2. Se você selecionar o botão de polegar para baixo, precisará fornecer mais informações. Opcionalmente, você pode escolher o motivo dos seus comentários negativos e deixar um comentário antes de selecionar Enviar comentários.

    Captura de tela do formulário usado para fornecer mais informações ao deixar comentários negativos sobre um comentário do Copilot.

Como solicitar uma nova revisão do Copilot

Quando você efetuar push de alterações para uma pull request que o Copilot revisou, ele não fará uma nova revisão das alterações automaticamente.

Para solicitar uma nova revisão do Copilot, selecione o botão ao lado do nome do Copilot no menu Revisores. Para obter mais informações, confira "Solicitar revisão de pull request".

Note

Ao fazer uma nova revisão de uma pull request, o Copilot poderá repetir os comentários, mesmo que eles tenham sido ignorados com o botão “Resolver conversa” ou reprovados com o botão de polegar para baixo (👎).

Como habilitar revisões automáticas do Copilot

Por padrão, você precisará solicitar manualmente uma revisão do Copilot em cada pull request.

Você pode habilitar revisões automáticas do Copilot em todas as pull requests usando conjuntos de regras configurados no repositório ou na organização. Para obter mais informações, confira "Sobre os conjuntos de regras".

Para ativar esse recurso, habilite a regra de branch Solicitar revisão da solicitação de pull request do Copilot, aninhada em Exigir uma pull request antes de mesclar.

Captura de tela da regra de branch “Solicitar revisão da solicitação de pull request do Copilot”.

Como personalizar as revisões do Copilot com diretrizes de codificação

Note

No momento, as diretrizes de codificação personalizadas só estão disponíveis para participantes selecionados na versão prévia pública da Revisão de código do Copilot. A aceitação com base na lista de espera não fornece acesso imediato. Além disso, as diretrizes de codificação personalizadas só estão disponíveis como parte de uma assinatura do GitHub Copilot Enterprise.

Ao usar o Revisão de código do Copilot para revisar as alterações no Visual Studio Code ou no site do GitHub, você pode personalizar a revisão do Copilot com diretrizes de codificação personalizadas escritas em linguagem natural. O Copilot fornecerá comentários com base nas suas diretrizes de codificação ao revisar o código. Para obter mais informações, confira "Como configurar diretrizes de codificação para a revisão de código do GitHub Copilot".

Os comentários gerados com base em uma diretriz de codificação incluirão uma mensagem, realçando a origem dela.

Captura de tela de um comentário produzido com base em uma diretriz de codificação personalizada.

Estas instruções explicam como usar a Revisão de código do Copilot no Visual Studio Code. Para ver as instruções para o site do GitHub, use o seletor de ferramentas “Navegador da Web” na parte superior da página.

Note

A Revisão de código do Copilot só está disponível no Visual Studio Code com a versão 0.22 ou posterior da extensão GitHub Copilot Chat.

Como revisar uma seleção de código

Você pode solicitar uma revisão inicial de uma seleção realçada do código no Visual Studio Code.

  1. No Visual Studio Code, selecione o código que deseja revisar.

  2. Abra a VS Code Command Palette

    • Para Mac:
      • Use: Shift+Command+P
    • Para Windows ou Linux:
      • Use Ctrl+Shift+P
  3. Na paleta de comandos, procure e selecione GitHub Copilot: Revisão e Comentário.

    Captura de tela da paleta de comandos no Visual Studio Code com o comando GitHub Copilot: Revisão e Comentário selecionado.

  4. Aguarde o Copilot revisar suas alterações. Normalmente, isso leva menos de 30 segundos.

    Captura de tela do indicador de progresso durante uma revisão do Copilot no Visual Studio Code.

  5. Se o Copilot tiver algum comentário, ele será mostrado embutido no arquivo e na guia Problemas.

    Captura de tela de um comentário do Copilot no Visual Studio Code.

Analisando alterações

Note

Atualmente, a revisão de alterações só está disponível para um número limitado de assinantes do Copilot. Para entrar na lista de espera, confira “Entrar na lista de espera da Revisão de código do Copilot”.

Você pode solicitar uma revisão das alterações preparadas ou não preparadas no Visual Studio Code.

  1. No VS Code, alterne para a guia Controle do Código-fonte.

  2. Para solicitar uma revisão das alterações não preparadas, posicione o cursor sobre Alterações na barra lateral e selecione o botão Revisão de código do Copilot – Alterações.

    Captura de tela do botão "Revisão de código do Copilot – Alterações" no Visual Studio Code. O botão Revisão de código está contornado em laranja-escuro.

  3. Para solicitar uma revisão das alterações preparadas, posicione o cursor sobre Alterações Preparadas na barra lateral e selecione o botão Revisão de código do Copilot – Alterações Preparadas.

  4. Aguarde o Copilot revisar suas alterações. Normalmente, isso leva menos de 30 segundos.

    Captura de tela do indicador de progresso durante uma revisão do Copilot no Visual Studio Code.

  5. Se o Copilot tiver algum comentário, ele será mostrado embutido nos arquivos e na guia Problemas.

    Captura de tela de um comentário do Copilot no Visual Studio Code.

Como trabalhar com as sugestões de alterações fornecidas pelo Copilot

Sempre que possível, os comentários do Copilot incluem sugestões de alterações que você pode aplicar com um só clique.

Captura de tela de um comentário do Copilot no Visual Studio Code com uma sugestão de alteração.

Se você estiver satisfeito com a alteração, poderá aceitar uma sugestão do Copilot selecionando o botão Aplicar e Ir para Próxima. Não é feito o commit automático das alterações aplicadas.

Caso não deseje aplicar a sugestão de alteração do Copilot, selecione o botão Descartar e Ir para Próxima.

Como fornecer comentários sobre as revisões do Copilot

Você pode fornecer comentários sobre os comentários do Copilot diretamente em cada comentário. Usamos essas informações para aprimorar o produto e a qualidade das sugestões do Copilot.

Para fornecer comentários, posicione o cursor sobre o comentário e selecione o botão de polegar para cima ou para baixo.

Captura de tela de um comentário do Copilot no Visual Studio Code com os botões de comentários exibidos. Os botões estão contornados em laranja-escuro.

Como personalizar as revisões do Copilot com diretrizes de codificação

Note

No momento, as diretrizes de codificação personalizadas só estão disponíveis para participantes selecionados na versão prévia pública da Revisão de código do Copilot. A aceitação com base na lista de espera não fornece acesso imediato. Além disso, as diretrizes de codificação personalizadas só estão disponíveis como parte de uma assinatura do GitHub Copilot Enterprise.

Ao usar o Revisão de código do Copilot para revisar as alterações no Visual Studio Code ou no site do GitHub, você pode personalizar a revisão do Copilot com diretrizes de codificação personalizadas escritas em linguagem natural. O Copilot fornecerá comentários com base nas suas diretrizes de codificação ao revisar o código. Para obter mais informações, confira "Como configurar diretrizes de codificação para a revisão de código do GitHub Copilot".

Os comentários gerados com base em uma diretriz de codificação incluirão uma mensagem, realçando a origem dela.