Skip to main content

Interpretando os resultados da qualidade do código do seu repositório

Veja os resultados de GitHub Code Quality para sua ramificação padrão.

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.

Pré-requisitos

Exibindo o backlog completo dos resultados de qualidade do código

  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.

Como alternativa, se você quiser exibir as descobertas alimentadas por IA para os arquivos alterados mais recentemente, consulte Aprimorando a qualidade do código mesclado recentemente com a IA.

Explorando o backlog do seu repositório

O painel "Descobertas padrão" mostra todos os resultados encontrados pela análise CodeQL na ramificação padrão do seu repositório. Essa exibição ajuda você a visualizar a lista de pendências completa dos resultados de qualidade e priorizar o trabalho para corrigir tipos específicos de problemas.

A visão geral, na parte superior da página, resume a manutenção e a confiabilidade da base de código.

Captura de tela do painel "Descobertas padrão" mostrando os resultados de qualidade de código. O resumo é descrito em laranja escuro.

Abaixo da visão geral, a lista completa de resultados é mostrada com um cabeçalho com filtros que você pode usar para se concentrar em um conjunto específico de descobertas. Os resultados são:

  • Agrupado pela regra que detectou cada descoberta
  • Dentro de cada regra, ordenada por caminho de arquivo em ordem alfabética

Explore os resultados expandindo uma regra para listar os arquivos afetados e clicando no nome de uma regra para ver detalhes completos das descobertas.

Captura de tela da tabela de regras no painel "Descobertas padrão" para qualidade de código. O nome da regra "Propriedade sobrescrita" está destacado em laranja escuro.

Interpretando classificações e métricas

Os resultados da qualidade do código sempre devem ser interpretados no contexto do repositório. Por exemplo:

  • Repositórios pequenos ou repositórios com apenas uma pequena quantidade de código escrito em linguagens com suporte tendem a ter poucos resultados e boas classificações.
  • Repositórios com muito código gerado podem ter muitos resultados de manutenção, reduzindo a classificação para manutenção. Isso não será um problema se o código-fonte em si for mantenedível.
  • Repositórios grandes com muito código em uma linguagem totalmente compatível geralmente têm muitos resultados, mesmo que a maioria do código tenha bons padrões de manutenção e confiabilidade.

Para saber mais sobre as métricas e como as classificações são calculadas, consulte Referência de métricas e classificações.

Próximas etapas