# Справочник по метрикам и оценкам

Поймите терминологию, используемую для GitHub оценки качества кода вашего репозитория.

В этой статье приведены определения метрик и показателей, используемых Code Quality.

Вы можете увидеть результаты на основе правил для вашего репозитория на вкладке **<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** , в **Стандартные выводы** вкладке под "<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> Качество кода.

## Определения метрик

В следующей таблице приведены определения для каждой метрики, которая сообщается для репозитория.

| Metric                 | Определение                                                                                                                                                                                                                                             | Примеры выводов                                                                                                 |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| **Надёжность**         | Оцените, выполняет ли код свою предназначенную функцию правильно, предсказуемо и последовательно. Надежный код не содержит ошибок, безопасно обрабатывает ошибки и работает должным образом в нормальных и пограничных условиях.                        | Проблемы с производительностью, параллелизмом, обработкой ошибок, правильностью                                 |
| **Ремонтопригодность** | Оцените, насколько легко понять, изменить и расширить код с течением времени. Поддерживаемый код следует передовым практикам, позволяет избежать ненужной сложности и организован таким образом, чтобы упростить будущие изменения и совместную работу. | Неиспользуемый или мертвый код, удобочитаемость, сложность, конфликтующее именование, плохое разделение проблем |

## Уровни серьезности

Уровни серьезности используются для указания потенциального влияния или срочности определения качества кода. Они помогают пользователям расставлять приоритеты в усилиях по устранению неполадок и сообщать заинтересованным сторонам о рисках. Серьёзность определяется правилом, которое выявило проблему, в соответствии с CodeQL традициями и отраслевыми стандартами.

| Серьёзность        | Определение                                                                                                                                                                          |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Error**          | Указывает на проблему высокой степени серьезности, которая может привести к ошибкам, сбоям или серьезным рискам удобства обслуживания.                                               |
| **Предупреждение** | Указывает на проблему средней степени серьезности, которая может повлиять на качество или надежность кода, но не является критической в данный момент.                               |
| **Заметка**        | Указывает на проблему низкой степени серьезности, незначительное улучшение или рекомендацию. Эти результаты полезны для поддержания работоспособности и удобства сопровождения кода. |

## Определения показателей

Эти оценки используются для суммирования общей надежности и удобства обслуживания репозитория на основе серьезности результатов на основе правил, обнаруженных CodeQL сканированием полной ветви по умолчанию:

| Результаты   | Definition                                                                                                             | Критерии (на основе полученных данных)       |
| ------------ | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| **отличные** | Codebase демонстрирует передовые методы обеспечения надежности и удобства обслуживания.                                | Не обнаружено никаких данных о качестве кода |
| **Хороший**  | В Codebase есть проблемы с низким уровнем серьезности или предлагаются незначительные улучшения.                       | ≥1 Определение уровня "Примечание"           |
| **Ярмарка**  | В Codebase есть проблемы средней степени серьезности, которые могут повлиять на качество, но не являются критическими. | ≥1 Определение уровня "Предупреждение"       |
| **Бедных**   | Codebase имеет проблемы высокой степени серьезности, включая ошибки или серьезные риски удобства обслуживания.         | ≥1 Определение уровня "Ошибка"               |

## Покрытие кода

Дополнительные сведения о том, как Code Quality меры и отчеты о охвате кода см. в разделе [Code coverage reference](/ru/code-security/reference/code-quality/code-coverage).

## Дополнительные материалы

* [Качество кода GitHub](/ru/code-security/concepts/code-quality/code-quality)
* [Интерпретация результатов оценки качества кода для репозитория](/ru/code-security/how-tos/maintain-quality-code/interpret-results)