Referência de métricas e classificações

Este artigo fornece definições para as métricas e classificações usadas por Code Quality.

Você pode ver os resultados baseados em regras para o repositório na guia Security and quality, na guia Descobertas padrão em " Qualidade do código".

Definições de Métrica

A tabela a seguir fornece definições para cada métrica relatada para seu repositório.

Métrica	Definition	Descobertas de exemplo

          **Reliability**   | Avalie se o código executa a função pretendida corretamente, previsível e consistentemente. O código confiável é livre de bugs (erros), lida com erros com segurança e opera conforme o esperado em condições normais e de limite. | Problemas com desempenho, simultaneidade, tratamento de erros, correção, design de API, acessibilidade, internacionalização ou segurança |

| Facilidade de manutenção | Avalie como é fácil entender, modificar e estender o código ao longo do tempo. O código mantenedível segue as práticas recomendadas, evita a complexidade desnecessária e é organizado para facilitar as alterações futuras e a colaboração. | Não usar práticas recomendadas, código não utilizado/morto, código duplicado, complexidade, redundâncias lógicas, documentação inadequada, problemas de dependência |

Níveis de severidade

Os níveis de gravidade são usados para indicar o impacto potencial ou a urgência de uma descoberta de qualidade de código. Eles ajudam os usuários a priorizar os esforços de correção e comunicar riscos aos stakeholders. A gravidade é determinada pela regra que detectou o problema, seguindo as convenções de CodeQL e padrões do setor.

Severity	Definition

          **Error** | Indica um problema de alta gravidade que provavelmente causará bugs, falhas ou principais riscos de manutenção. |

| Aviso | Indica um problema de gravidade moderada que pode afetar a qualidade ou a confiabilidade do código, mas não é imediatamente crítico. | | Observação | Indica um problema de baixa gravidade, um pequeno aprimoramento ou uma recomendação. Essas descobertas são úteis para a integridade e a manutenção contínuas do código. |

Definições de classificações

Essas classificações são usadas para resumir a confiabilidade geral e a manutenibilidade de um repositório, avaliadas com base na gravidade dos resultados obtidos a partir de regras encontradas por CodeQL verificações da ramificação padrão completa.

Rating	Definition	Critérios (com base em descobertas)

          **Excelente**        | O Codebase demonstra as melhores práticas de confiabilidade e manutenção. | Nenhuma descoberta de qualidade de código detectada                              |

| Boa | A base de código tem problemas de baixa gravidade ou pequenas melhorias são sugeridas. | ≥1 conclusão de nível "Nota" | | Razoável | O Codebase tem problemas de gravidade moderada que podem afetar a qualidade, mas não são críticos. | ≥1 conclusão de nível "Aviso" | | Precisa de melhorias| O Codebase tem problemas de alta gravidade, incluindo bugs ou principais riscos de manutenção. | ≥1 conclusão de nível "Erro" |

Leitura adicional

•         [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality)
  

•         [AUTOTITLE](/code-security/code-quality/how-tos/interpret-results)