Skip to main content

Uso responsável da revisão de código do GitHub Copilot

Saiba como usar a Revisão de código do GitHub Copilot com segurança e responsabilidade compreendendo as finalidades, as funcionalidades e as limitações.

Sobre a Revisão de código do GitHub Copilot

A Revisão de código do GitHub Copilot é um recurso alimentado por IA que revisa o código e fornece comentários.

Quando um usuário solicita uma revisão de código do Copilot, o Copilot examina as alterações de código, além do contexto relevante adicional, e fornece comentários sobre o código. Como parte desses comentários, ele também pode fornecer sugestões de alterações de código específicas.

A revisão do Copilot pode ser personalizada com instruções específicas, que são descrições em linguagem natural do estilo de codificação e melhores práticas. Para saber mais, confira Como adicionar instruções personalizadas de repositório no GitHub Copilot.

O único idioma com suporte na Revisão de código do GitHub Copilot é o inglês.

A Revisão de código do GitHub Copilot inspeciona o código e fornece comentários usando uma combinação de processamento de linguagem natural e aprendizado de máquina. Esse processo pode ser dividido em várias etapas.

Processamento de entrada

As alterações de código são combinadas com outras informações contextuais relevantes (por exemplo, o título e o corpo da pull request no GitHub) e instruções personalizadas que tenham sido definidas, a fim de formar um prompt. Em seguida, esse prompt é enviado para um grande modelo de linguagem.

Análise de modelo de linguagem

Em seguida, a solicitação pré-processada passa pelo modelo de linguagem do Copilot, que é uma rede neural treinada em um corpo grande de dados de texto. O modelo de linguagem analisa o prompt de entrada.

Geração de resposta

O modelo de linguagem gera uma resposta com base na análise do prompt de entrada. Essa resposta pode assumir a forma de sugestões de linguagem natural e sugestões de código.

Formatação de saída

A resposta gerada pelo Copilot é apresentada ao usuário diretamente no editor com suporte ou como uma revisão da solicitação de pull request no GitHub, fornecendo comentários de código vinculados a linhas específicas de arquivos específicos.

Quando o Copilot fornece uma sugestão de código, a sugestão é apresentada como uma alteração sugerida, que pode ser aplicada com alguns cliques.

Uso do modelo

O Revisão de código do Copilot é um produto que usa uma combinação cuidadosamente ajustada de modelos, prompts e comportamentos do sistema para fornecer feedback consistente e de alta qualidade em uma ampla variedade de bases de código. Não há suporte para a alternância de modelos, pois alterar o modelo provavelmente comprometerá a confiabilidade, a experiência do usuário e a qualidade dos feedbacks de revisão. Cada uso desse recurso consome uma solicitação premium. Confira Solicitações no GitHub Copilot.

Observação

O Revisão de código do Copilot pode usar modelos que não estão habilitados na página de configurações "Models" da sua organização. Confira Gerenciar políticas e recursos do GitHub Copilot na sua organização.

Caso de uso do Revisão de código do GitHub Copilot

O objetivo da Revisão de código do GitHub Copilot é fornecer comentários rapidamente sobre o código de um desenvolvedor. Com isso, os desenvolvedores podem preparar o código para mesclá-lo mais rapidamente e aprimorar a qualidade geral do código.

Como aprimorar o desempenho da Revisão de código do GitHub Copilot

Use a Revisão de código do Copilot para complementar as revisões humanas, não para substituí-las

Embora a Revisão de código do GitHub Copilot possa ser uma ferramenta eficiente para aprimorar a qualidade do código, é importante usá-la como uma ferramenta, em vez de substituir as revisões humanas.

Você sempre deve revisar e verificar os comentários gerados pela Revisão de código do Copilot e complementar os comentários do Copilot com uma cuidadosa revisão humana, a fim de garantir que o código atenda às suas necessidades.

Enviar comentários

Caso você encontre problemas ou limitações com a Revisão de código do Copilot, recomendamos que forneça comentários usando os botões de polegar para cima e para baixo nos comentários do Copilot. Isso pode ajudar o GitHub a aprimorar a ferramenta e resolver questões ou limitações.

Instruções personalizadas

Você pode configurar instruções personalizadas para ajudar o Copilot a entender seu estilo de codificação e suas melhores práticas. Para saber mais, confira Como adicionar instruções personalizadas de repositório no GitHub Copilot.

Limitações da Revisão de código do GitHub Copilot

Dependendo de fatores como a base de código e a linguagem de programação, talvez você encontre diferentes níveis de desempenho ao usar a Revisão de código do GitHub Copilot. As informações a seguir ajudam a entender as limitações do sistema e os principais conceitos sobre desempenho, conforme se aplicam à Revisão de código do GitHub Copilot.

Problemas de qualidade de código não apontados

É possível que o Copilot não identifique todos os problemas presentes no código, especialmente quando as alterações são grandes ou complexas. Para garantir que todos os problemas relevantes sejam identificados e corrigidos, a Revisão de código do Copilot deve ser complementada com uma cuidadosa revisão de código feita por humanos.

Falsos positivos

A Revisão de código do Copilot tem um risco de “alucinação”, ou seja, ela poderá realçar problemas que não existem no código revisado ou que se baseiam em equívocos sobre o código. Os comentários gerados pela Revisão de código do Copilot devem ser cuidadosamente revisados e considerados antes que você tome medidas e faça alterações.

Código impreciso ou não seguro

Como parte dos comentários, a Revisão de código do Copilot poderá fornecer sugestões de código específicas. O código gerado poderá parecer válido, mas talvez não esteja semântica ou sintaticamente correto ou não resolva corretamente o problema identificado no comentário. Além disso, o código gerado pelo Copilot poderá conter vulnerabilidades de segurança ou outros problemas. Você sempre deve revisar e testar cuidadosamente o código gerado pelo Copilot.

Possíveis desvios

Os dados de treinamento do Copilot são extraídos de repositórios de código existentes, que podem conter desvios e erros que poderão ser perpetuados pela ferramenta. Além disso, a Revisão de código do Copilot pode ser tendenciosa em relação a determinadas linguagens de programação ou estilos de codificação, o que pode resultar em comentários abaixo do ideal ou incompletos.

Próximas etapas

Para obter detalhes de como usar a Revisão de código do Copilot, confira: