Skip to main content

Aprimorando a qualidade do código mesclado recentemente com a IA

Explore as descobertas de GitHub Code Quality no código mesclado recentemente e corrija-as com Copilot Autofix ou delegue a correção para agente de nuvem Copilot.

Quem pode usar esse recurso?

Usuários com com acesso para gravação

GitHub Team ou GitHub Enterprise Cloud

Observação

GitHub Code Quality está atualmente em versão prévia pública e sujeito a alterações. Durante versão prévia pública, Code Quality não será cobrado, embora as verificações de Code Quality consumirão GitHub Actions minutos.

Introdução

Este tutorial mostra como explorar e corrigir problemas de qualidade identificados pela análise com IA do Code Quality no código recentemente mesclado na sua branch padrão.

Quando você melhora a qualidade dos arquivos mesclados recentemente, reduz a dívida técnica no repositório e facilita o trabalho de outros desenvolvedores em arquivos que estão em desenvolvimento ativo.

          Code Quality tem duas linhas de defesa

          Code Quality verifica solicitações de pull e comentários sobre questões de qualidade e **, em seguida, executa uma segunda verificação de IA** depois que a solicitação de pull é mesclada. Os dois tipos de verificação usam tecnologias complementares:
  •           **As verificações de pull requests** usam regras CodeQL para identificar problemas. Essa análise é completamente testada, boa para identificar onde o código não corresponde às regras de qualidade e pode analisar muitos arquivos. No entanto, ele dá suporte a um subconjunto de linguagens de codificação e não pode identificar problemas em que não haja nenhuma regra.
    
  •           **As verificações de arquivos mesclados recentemente** usam um modelo de linguagem amplo para analisar seus arquivos mais recentes e relatar descobertas em até 5 arquivos. Essa análise examina seu código em todos os idiomas, sem ser limitada por regras, e fornece insights contextuais e sugestões que podem ir além do que CodeQL as regras oferecem.
    

Pré-requisitos

  •         Code Quality está habilitado, consulte [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
    
  • Pelo menos um pull request foi mesclado desde que Code Quality foi habilitado.

1. Exibir as sugestões de IA para o repositório

Após uma verificação Code Quality dos arquivos recém-mesclados na sua ramificação padrão, você poderá ver os resultados na visualização Descobertas de IA, que exibe os resultados para até 5 arquivos.

  1. Navegue até a Security and quality guia do repositório.
  2. Clique para expandir Qualidade do código, então clique em Descobertas de IA.

Observação

Essa exibição estará vazia se o repositório estiver inativo ou se a análise de LLM não puder sugerir maneiras de melhorar a qualidade do código em pushs recentes para o branch padrão.

2. Explore as melhorias sugeridas para seu repositório

Na página Descobertas de IA, cada arquivo aparece com a quantidade de problemas de qualidade identificados e a data de envio para a ramificação padrão.

  • Clique em um nome de arquivo para exibir detalhes dos problemas de qualidade detectados e das correções sugeridas.

Captura de tela da visualização "Descobertas de IA" para a qualidade do código.

3. Delegar o trabalho de correção ou abrir solicitações de pull por conta própria

Você pode abrir uma solicitação de pull request para aplicar as correções automáticas sugeridas a um arquivo ou delegar a correção para agente de nuvem Copilot. Você precisa de uma Copilot licença para atribuir trabalho a agente de nuvem Copilot.
Inscrever-se para Copilot

Delegar trabalho para agente de nuvem Copilot

Também é possível solicitar que agente de nuvem abra solicitações de pull request com melhorias nos arquivos, usando as alterações sugeridas como prompt. Essa é a melhor opção se as alterações sugeridas parecerem boas para você e você quiser abrir uma solicitação de pull que aplique correções a mais de um arquivo.

Para delegar a criação de pull requests:

  •         **Vários arquivos:** Selecione os arquivos que você deseja incluir e clique em **Atribuir os selecionados a Copilot** no cabeçalho da lista de arquivos.
    
  •         **Um arquivo:** Clique **Atribuir para Copilot** o arquivo.
    

Há um pequeno atraso enquanto agente de nuvem configura o trabalho. Quando o pull request está aberto e o trabalho está em andamento, um banner é exibido com um link para o pull request.

Você pode acompanhar o andamento do trabalho de agente de nuvem Copilot:

Abra suas próprias solicitações pull

Você pode abrir pull requests por conta própria para aplicar sugestões de auto-correção. Essa será a melhor opção se:

  • Você pode optar por trabalhar nas alterações localmente ou em GitHub Desktop antes de abrir uma solicitação de pull request
  • Você não tem acesso a agente de nuvem Copilot

Observação

Ao abrir uma solicitação de pull por conta própria, você só pode confirmar correções em um arquivo de cada vez. Para corrigir vários arquivos ao mesmo tempo, você deve usar agente de nuvem Copilot.

Abrindo uma solicitação de pull

  1. Clique no nome do arquivo para exibir detalhes dos problemas de qualidade detectados.

  2. Examine os problemas e as correções sugeridas.

  3. Expanda o menu suspenso Atribuir a Copilot e selecione Abrir solicitação de pull request para alterar a opção padrão para "Abrir solicitação de pull request". Sua preferência é lembrada.

    Captura de tela da visualização "Descobertas de IA" para a qualidade do código.

  4. Clique em Abrir solicitação de pull para abrir uma caixa de diálogo de opções de confirmação.

  5. Clique em Confirmar alteração para criar uma solicitação de pull com as correções.

4. Fornecer contexto aos revisores de solicitação de pull

Fornecer contexto sobre por que você está propondo alterações no código é a melhor maneira de incentivar os membros da equipe a revisar sua solicitação de pull. Se você usou agente de nuvem Copilot, o resumo da solicitação de pull já inclui detalhes completos dos problemas corrigidos pela solicitação de pull.

Se você abriu o pull request diretamente da visualização GitHub Code Quality, o resumo do pull request será vinculado à visualização Descobertas de IA. Talvez você queira copiar algumas das explicações da visualização Descobertas de IA para a descrição do pull request.

Captura de tela do resumo de uma solicitação pull criada por GitHub Code Quality.

5. Veja suas alterações terem um impacto em Descobertas de IA

Quando você retorna ao modo de exibição "Descobertas de IA" depois de mesclar sua solicitação de pull, as descobertas corrigidas não são mais listadas.

Próximas etapas