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

Entenda a terminologia usada por GitHub para avaliar a qualidade do código do seu repositório.

> \[!NOTE]
> 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.

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 **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality**, na guia **Descobertas padrão** em "<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-code-review" aria-label="code review" role="img"><path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0 1 14.25 13H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25v-8.5C0 1.784.784 1 1.75 1ZM1.5 2.75v8.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-8.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Zm5.28 1.72a.75.75 0 0 1 0 1.06L5.31 7l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.75.75 0 0 1 1.06 0Zm2.44 0a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L10.69 7 9.22 5.53a.75.75 0 0 1 0-1.06Z"></path></svg> 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

* [Sobre a qualidade do código no GitHub](/pt/code-security/code-quality/concepts/about-code-quality)
* [Interpretando os resultados da qualidade do código do seu repositório](/pt/code-security/code-quality/how-tos/interpret-results)