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 analisa seu branch padrão e relata os resultados nas páginas "Qualidade do código" na guia Security and quality do seu 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 uma constatação padrã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 autofixo no branch", selecione "Abrir uma solicitação de pull" e clique em Confirmar alteração.
4. Quando o pull request de autofix estiver pronto para revisão, altere o status dele de "Draft" para "Ready for review" e aguarde até que as verificações de CI sejam aprovadas antes de fazer o merge.
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.

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

Depois que suas solicitações de pull de autofixo forem mescladas, retorne ao modo de exibição "Descobertas padrão" para confirmar que:

• 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