Corrigindo problemas de qualidade do código antes de mesclar sua solicitação de pull

Introdução

Este tutorial mostra como trabalhar com GitHub Code Quality solicitações de pull para identificar os problemas de qualidade de código que as suas alterações podem introduzir inadvertidamente e como resolver e resolver descobertas de qualidade de código com Copilot Autofix e agente de nuvem Copilot.

Benefícios de identificar problemas antecipadamente

Capturar problemas de qualidade de código antecipadamente mantém a base de código da equipe em forma. GitHub Code Quality verifica seu código para:

•         **Confiabilidade**: por exemplo, erros lógicos, tratamento de erros não seguros ou condições de corrida que podem fazer com que seu aplicativo falhe ou se comporte de forma imprevisível. Ao resolver esse tipo de problema antecipadamente, você torna seu software mais robusto e confiável para os usuários.
  

•         **Manutenção**: por exemplo, código duplicado, lógica excessivamente complexa, variáveis não usadas ou violações das práticas recomendadas de codificação. Corrigir esses problemas torna seu código mais limpo e fácil de ler, portanto, as alterações futuras são mais rápidas e menos arriscadas.
  

1. Entender como GitHub Code Quality funciona em solicitações de pull

Quando você abre uma solicitação de pull, GitHub Code Quality usa CodeQL para verificar automaticamente suas alterações em busca de problemas de qualidade, como os descritos acima.

Os resultados da CodeQL verificação são relatados como comentários em sua solicitação de pull, deixados pelo github-code-quality[bot]. Cada comentário corresponde a um problema específico de qualidade de código detectado em suas alterações e vem com um autofixo sugerido.

Os comentários são rotulados por severidade (Erro, Aviso, Observação), para que você possa ver quais descobertas são as mais críticas a serem resolvidas.

2. Priorizar correções com base na gravidade

Examine os comentários e identifique os achados que têm o nível de severidade mais alto ("Erro") primeiro.

Se não houver nenhuma conclusão de "Erro", procure os resultados do próximo nível de gravidade ("Aviso"), e assim por diante.

Descobertas de alta severidade indicam problemas de qualidade de código mais graves que são mais propensos a introduzir problemas de confiabilidade ou manutenção em sua base de código. Ao resolver as descobertas de alta gravidade, você está fazendo o trabalho mais impactante para manter a qualidade do código da sua equipe.

3. Aproveitar Copilot Autofix ou agente de nuvem Copilot para corrigir resultados

Copilot Autofix

Os comentários na solicitação pull incluem um autofix sugerido que você pode confirmar diretamente na sua solicitação pull. Analise cuidadosamente a correção automática sugerida para lógica, segurança e estilo e clique em Confirmar sugestão.

Você não precisa de uma licença Copilot para aplicar essas sugestões.

agente de nuvem Copilot

Como alternativa, se você tiver uma Copilot licença, poderá delegar o trabalho de correção para agente de nuvem Copilot. Comente na solicitação de pull mencionando @Copilot e solicite que Copilot corrija os problemas detectados.

          Copilot responde com um emoji de olhinhos (👀) ao seu comentário, inicia uma nova sessão de agente e abre um pull request com as correções necessárias.

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

• Na solicitação de pull, o resumo é atualizado à medida que o trabalho progride.
• Usando a página de agentes ou os logs de sessão, consulte Acompanhando as sessões do GitHub Copilot.

Você precisa de uma Copilot licença para invocar agente de nuvem Copilot.
Inscrever-se para Copilot

4. Ignorar descobertas irrelevantes

Você pode descartar um achado se ele não for relevante ou acionável no contexto de sua base de código. Os motivos comuns para ignorar uma descoberta incluem:

• A descoberta está no código legado que não é mais suportado.
• É uma exceção conhecida para os padrões de codificação da sua equipe.
• É um falso positivo que não representa um risco real de qualidade.

Ignorar alertas irrelevantes mantém suas verificações de qualidade focadas em problemas significativos.

5. Envie as alterações e aguarde a verificação

Depois de corrigir ou ignorar as conclusões, faça push das suas alterações para a ramificação associada à sua solicitação de pull. GitHub Code Quality examinará automaticamente suas alterações e atualizará os comentários no seu pull request de forma adequada.

6. Verifique as classificações de qualidade de código do repositório

Qualquer pessoa com acesso de gravação pode exibir as classificações gerais de qualidade de código de um repositório, que resumem o estado da confiabilidade e da manutenção do código em toda a ramificação padrão.

Para exibir as classificações do seu repositório, navegue até a Security and quality guia do seu repositório, expanda Qualidade do código na barra lateral e clique em Descobertas padrão.

Ao resolver problemas antes de mesclar sua solicitação de pull, você contribuiu diretamente para manter essas classificações.

Próximas etapas

• Resolva os problemas de qualidade do código em seu branch padrão e entenda as pontuações de confiabilidade e manutenibilidade do repositório. Confira Aprimorando a qualidade do código do repositório.
• Forneça comentários sobre GitHub Code Quality na discussão da comunidade.