Explorando os resultados de qualidade de código do GitHub em sua organização

Pré-requisitos

• Se sua organização pertencer a uma empresa, um proprietário da empresa deverá habilitar Code Quality para sua organização. Consulte Permitindo o uso de GitHub Code Quality na sua empresa.
• Sua organização deve ter repositórios com Code Quality habilitado. Consulte Habilitando o GitHub Code Quality.

Exibindo insights de qualidade de código para sua organização

O painel em nível de organização tem duas guias:

• A aba Saúde mostra uma visão geral da saúde atual do código da sua organização.
• A guia Tendências mostra como as descobertas abertas foram alteradas durante um período de tempo selecionado, para que você possa acompanhar o progresso e identificar repositórios que precisam de atenção.

1. Em GitHub, navegue até a página principal da sua organização. Por exemplo, de https://github.com/settings/organizations.
2. No nome da sua organização, clique na Security and quality aba.
3. Na seção "Insights" da barra lateral, clique em Qualidade do código.

Filtrando dados do painel

Uma barra de filtros na parte superior do painel se aplica tanto à guia Saúde quanto à guia Tendências. Você pode filtrar por:

• Pontuação de confiabilidade
• Pontuação de manutenibilidade
• Descobertas padrão
• Descobertas de IA
• Tópico
• Equipe
• Visibilidade
• Quaisquer propriedades personalizadas definidas para sua organização

Você também pode classificar os dados do painel usando o controle Classificar na mesma barra de filtros.

Visualizando a saúde atual do código

A aba Saúde mostra uma visão geral da saúde do código da sua organização neste momento.

Interpretando o gráfico de distribuição de pontuação

O gráfico de distribuição de pontuação fornece uma visão geral visual da integridade do código da sua organização. Cada bolha representa uma coleção de repositórios com as mesmas pontuações de manutenção e confiabilidade.

• A posição de cada bolha demonstra a integridade geral desses repositórios. Bolhas mais altas representam pontuações de manutenção mais altas, enquanto bolhas mais à direita representam pontuações de confiabilidade mais altas.
• A cor e o padrão de borda de uma bolha indicam a gravidade da pontuação inferior para esses repositórios. Por exemplo, uma bolha com uma pontuação "Ruim" em qualquer categoria sempre será vermelha com uma borda tracejada.
• O tamanho de cada bolha representa o número de repositórios com essa combinação de pontuação específica.

Para exibir a pontuação de manutenção, a pontuação de confiabilidade e o número de repositórios representados por uma bolha específica, passe o mouse sobre a bolha.

Explorando a tabela do repositório

Abaixo do gráfico de bolhas, há uma tabela que lista todos os repositórios em sua organização. Aqui, você pode exibir as descobertas de qualidade do código, juntamente com informações mais detalhadas sobre essas descobertas.

Você pode classificar a tabela de repositório em ordem crescente ou decrescente para qualquer coluna clicando no cabeçalho da coluna.

Investigando repositórios de baixa pontuação

1. Para filtrar os dados do painel para os repositórios de menor desempenho, no gráfico de distribuição de pontuação, clique na bolha com as pontuações combinadas mais baixas.
2. Role para baixo até a tabela do repositório. Por padrão, a tabela é classificada da verificação de repositório mais recente para a menos recente, ajudando você a priorizar os problemas de qualidade atuais.
3. Opcionalmente, para priorizar repositórios com o maior número de CodeQL descobertas, clique Descobertas padrão duas vezes.
4. Para exibir o painel no nível do repositório para um repositório específico, clique no nome do repositório.

Acompanhar tendências de qualidade ao longo do tempo

A aba Tendências mostra como as descobertas abertas nos repositórios aos quais você tem acesso e que correspondem aos filtros atuais mudaram ao longo do tempo, para que você possa verificar se o seu trabalho de qualidade de código está surtindo efeito e onde concentrar sua atenção em seguida.

1. No painel no nível da organização, clique na guia Tendências .
2. Use a lista suspensa Período para selecionar um intervalo de tempo: os últimos 7, 14 ou 30 dias.
3. Analise o gráfico "Achados em aberto ao longo do tempo", que mostra o número total de achados em aberto nos repositórios aplicáveis para o período selecionado.
4. Opcionalmente, use os botões acima do gráfico para agrupar os dados por índice de integridade ou severidade.
5. Passe o cursor sobre um ponto no gráfico para ver o número de achados abertos naquele dia.

Noções básicas sobre os dados de tendências

Tenha o seguinte em mente ao interpretar o grafo:

• O gráfico é baseado em capturas diárias de achados abertos. Se nenhuma análise for executada em um determinado dia, talvez não haja nenhum ponto de dados para esse dia.

• Os dados históricos só estão disponíveis desde que Code Quality começou a capturar snapshots, por isso o intervalo de tempo disponível pode ser limitado inicialmente.

• O grafo rastreia a contagem total de descobertas abertas, não as descobertas individuais que estão sendo abertas ou corrigidas. Uma alteração na contagem não significa necessariamente que os desenvolvedores corrigiram ou introduziram problemas.

• Habilitar Code Quality em repositórios adicionais pode aumentar a contagem de achados mostrada no gráfico. Um aumento depois de habilitar novos repositórios não significa necessariamente que a qualidade do código está diminuindo.

• O gráfico mostra a contagem total de resultados abertos dos repositórios que você está filtrando no momento. A contagem total inclui:

  • Novas descobertas introduzidas por alterações de código ou quando a análise de qualidade do código está habilitada em novos repositórios
  • Descobertas que são corrigidas no código ou ignoradas pelos usuários

Identificando repositórios que precisam de atenção

Abaixo do gráfico de tendências, duas tabelas ajudam a identificar quais repositórios precisam de atenção durante o período de tempo selecionado:

• A maioria dos repositórios aprimorados lista os repositórios com a maior redução nos achados abertos durante o período de tempo selecionado.
• Repositórios que precisam de melhorias lista os repositórios com o maior aumento de descobertas em aberto durante o período selecionado.

Ambas as tabelas incluem as seguintes colunas:

• Repositório: o nome do repositório.
• Total em aberto: o número de resultados em aberto no repositório ao final do período selecionado.
• Variação líquida: como a contagem de resultados abertos do repositório mudou no período selecionado.
• Descartado: Quantas descobertas foram descartadas para o repositório no período selecionado.

O número de descobertas de um repositório é afetado por descobertas que estão sendo corrigidas e descartadas. Você pode usar o painel no nível do repositório para confirmar o que foi alterado.

Para investigar um repositório, clique em seu nome para abrir seu painel no nível do repositório, no qual Code Quality você pode examinar as descobertas individuais e executar uma ação de correção.

Próximas Etapas 

Para entender as informações de integridade do código disponíveis no painel no nível do repositório, consulte Interpretando os resultados da qualidade do código do seu repositório.

Se você estiver planejando habilitar Code Quality em vários repositórios, consulte Implementando GitHub Code Quality em larga escala.