Corrigindo os problemas de qualidade do código apontados no backlog do seu repositório

Como Code Quality funciona na sua ramificação padrão

Code Quality examina a ramificação padrão e relata os resultados nas páginas "Qualidade do código" da guia Security and quality do repositório. Ele executa dois tipos de análise.

1. ** Descobertas padrão **: Code Quality usa CodeQL para realizar uma varredura determinística baseada em regras da sua ramificação padrão. Os resultados são agrupados por regra e idioma, classificados por gravidade (Erro, Aviso, Observação), e cada um inclui uma correção automática sugerida.

2. ** Descobertas de IA **: Code Quality usa a análise baseada em IA para identificar problemas de qualidade nos arquivos enviados mais recentemente para seu branch padrão, incluindo problemas que a análise baseada em regras pode não detectar , como práticas recomendadas, convenções de nomenclatura ou considerações de design.

Para obter informações sobre como resolver Descobertas de IA, consulte Corrigindo descobertas de qualidade de código em arquivos mesclados recentemente.

Resolvendo resultados padrão

Você pode resolver resultados individualmente ou atribuir vários resultados a Copilot.

Resolvendo uma única constatação

1. Navegue até a Security and quality guia do repositório.

2. Clique para expandir Qualidade do código, e clique em Descobertas padrão.

3. Use os filtros de painel para se concentrar nas descobertas mais propensas a afetar suas pontuações de qualidade. Por exemplo, para ver todas as descobertas no nível de "Erro" para "Confiabilidade", defina o filtro como:

   is:open category:reliability severity:error

4. As descobertas são agrupadas por regra. Clique no nome de uma regra para acessar uma visualização detalhada de todas as descobertas relacionadas a essa regra.

   

5. Clique em Mostrar mais e, em seguida, examine a explicação da regra, qual é a correção recomendada, dando suporte a exemplos de código e referências.

1. À direita de um resultado individual, clique em Gerar correção.
2. Examine a diferença da alteração proposta. Se você concordar com ele, clique em Abrir solicitação de pull.
3. Na caixa de diálogo "Confirmar correção automática da ramificação", selecione "Abrir uma pull request" e clique em Confirmar alteração.
4. Quando a pull request de correção automática estiver pronta para revisão, altere o status dela de "Rascunho" para "Pronto para revisão" e aguarde até que as verificações de CI sejam aprovadas antes da mesclagem.
5. Como alternativa, se uma descoberta não for relevante ou acionável, clique em Ignorar. Por exemplo, você pode descartar um achado que esteja em código legado que não recebe mais manutenção, que seja uma exceção conhecida aos padrões de codificação da sua equipe ou que seja um falso positivo que não represente um risco real à qualidade.

Para aumentar uma pontuação de confiabilidade ou de manutenção, você deve resolver cada descoberta no nível de severidade mais alto que afeta atualmente essa métrica. Consulte Referência de métricas e pontuações.

Atribuindo vários resultados a Copilot

Se você tiver muitos achados para uma regra e quiser corrigi-los com eficiência, poderá selecionar esses achados em massa e atribuí-los a Copilot para remediação agêntica. Copilot abrirá um pull request com correções para os resultados selecionados.

Você não precisa de uma licença Copilot para usar esse recurso, mas o proprietário da empresa deve permitir Code Quality para sua organização. Consulte Permitindo o uso de GitHub Code Quality na sua empresa.

Para obter os melhores resultados, comece com uma única regra que tenha muitos achados de alta gravidade. Isso permite validar a qualidade dos autofixos em um conjunto coeso de alterações antes de expandir para outras regras.

1. Navegue até a Security and quality guia do repositório.

2. Clique para expandir Qualidade do código, e clique em Descobertas padrão.

3. Selecione os resultados que você deseja corrigir. Você pode selecionar até 25 resultados por página, uma página por vez.

4. Clique em Atribuir para Copilot.

   

5. Copilot abrirá um pull request com correções para os resultados selecionados. Examine o pull request cuidadosamente antes de mesclar.

Verificando se as pontuações de qualidade do código foram atualizadas

Depois que as pull requests de correção automática forem mescladas, retorne à exibição "Descobertas padrão" para confirmar se:

• O número de achados diminuiu.
• A pontuação de manutenibilidade ou confiabilidade melhorou caso você tenha resolvido todos os problemas no nível mínimo de severidade atual dessa métrica.

Próximas Etapas 

• Corrigindo descobertas de qualidade de código em arquivos mesclados recentemente