Note
- A GitHub Copilot code review está em versão prévia pública e sujeita a alterações. Algumas funcionalidades estão disponíveis para todos os assinantes do Copilot, enquanto outras só estão disponíveis para um número limitado de usuários. Para entrar na lista de espera, confira “Entrar na lista de espera da Copilot code review”.
- O “Termos de licença de pré-lançamento do GitHub” se aplica ao uso deste produto.
Sobre a Copilot code review
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 Copilot code review 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:
| Recurso | Revisar a seleção | Analisar revisão |
|---|---|---|
| Descrição | Revisão inicial de uma seção realçada do código com comentários e sugestões | Revisão mais detalhada de todas as alterações |
| Suporte ao idioma | Tudo | C#, Go, Java, JavaScript, Markdown, Python, Ruby e TypeScript |
| Suporte a diretrizes de codificação personalizadas | Não | Sim, confira Como personalizar as revisões do Copilot com diretrizes de codificação |
| Ambiente | Visual Studio Code | Visual Studio Code e o site do GitHub |
| Disponibilidade | Versão prévia pública, disponível para todos os assinantes do Copilot | Versão prévia pública com lista de espera. Confira “Entrar na lista de espera da Copilot code review” |
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 Copilot code review 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 Copilot code review”.
-
Em GitHub.com, crie uma solicitação de pull ou navegue até uma existente.
-
Abra o menu Revisores e escolha Copilot.
-
Aguarde o Copilot revisar sua pull request. Normalmente, isso leva menos de 30 segundos.
-
Role a página para baixo e leia os comentários do 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".
-
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 "Using Copilot to help you work on a 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.
-
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 (👎).
-
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.
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.
Como personalizar as revisões do Copilot com diretrizes de codificação
Note
Custom coding guidelines are currently only available to selected participants in the versão prévia pública of Copilot code review. Being accepted from the waitlist does not provide immediate access. In addition, custom coding guidelines are only available as part of a subscription to GitHub Copilot Enterprise.
When using Copilot code review to review changes in Visual Studio Code or the GitHub website, you can customize Copilot's review with custom coding guidelines written in natural language. Copilot will give feedback based on your coding guidelines when it reviews your code. For more information, see "Configuring coding guidelines for GitHub Copilot code review."
Comments generated based on a coding guideline will include a message, highlighting their source.
Estas instruções explicam como usar a Copilot code review 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 Copilot code review 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.
-
No Visual Studio Code, selecione o código que deseja revisar.
-
Abra a VS Code Command Palette
- Para Mac:
- Use: Shift+Command+P
- Para Windows ou Linux:
- Use Ctrl+Shift+P
- Para Mac:
-
Na paleta de comandos, procure e selecione GitHub Copilot: Revisão e Comentário.
-
Aguarde o Copilot revisar suas alterações. Normalmente, isso leva menos de 30 segundos.
-
Se o Copilot tiver algum comentário, ele será mostrado embutido no arquivo e na guia Problemas.
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 Copilot code review”.
Você pode solicitar uma revisão das alterações preparadas ou não preparadas no Visual Studio Code.
-
No VS Code, alterne para a guia Controle do Código-fonte.
-
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 Copilot code review – Alterações.
-
Para solicitar uma revisão das alterações preparadas, posicione o cursor sobre Alterações Preparadas na barra lateral e selecione o botão Copilot code review – Alterações Preparadas.
-
Aguarde o Copilot revisar suas alterações. Normalmente, isso leva menos de 30 segundos.
-
Se o Copilot tiver algum comentário, ele será mostrado embutido nos arquivos e na guia Problemas.
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.
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.
Como personalizar as revisões do Copilot com diretrizes de codificação
Note
Custom coding guidelines are currently only available to selected participants in the versão prévia pública of Copilot code review. Being accepted from the waitlist does not provide immediate access. In addition, custom coding guidelines are only available as part of a subscription to GitHub Copilot Enterprise.
When using Copilot code review to review changes in Visual Studio Code or the GitHub website, you can customize Copilot's review with custom coding guidelines written in natural language. Copilot will give feedback based on your coding guidelines when it reviews your code. For more information, see "Configuring coding guidelines for GitHub Copilot code review."
Comments generated based on a coding guideline will include a message, highlighting their source.