メトリックと評価のリファレンス

この記事では、 Code Qualityで使用されるメトリックと評価の定義について説明します。

リポジトリのルールベースの結果は、[ Security and quality ] タブの [ 標準の結果 ] タブの [コードの品質] で確認できます。

メトリック定義

次の表に、リポジトリに対して報告される各メトリックの定義を示します。

メトリック	Definition	結果の例
Reliability	コードが目的の関数を正しく、予測可能かつ一貫して実行するかどうかを評価します。 信頼性の高いコードはバグから解放され、エラーを安全に処理し、通常およびエッジケースの条件下で期待どおりに動作します。	パフォーマンス、コンカレンシー、エラー処理、正確性、API 設計、アクセシビリティ、国際化、またはセキュリティに関する問題
保守容易性	時間の経過に伴うコードの理解、変更、および拡張がいかに簡単であるかを評価します。 保守可能なコードは、ベスト プラクティスに従い、不要な複雑さを回避し、将来の変更とコラボレーションを容易にするために編成されています。	ベストプラクティスを遵守していないこと、未使用／デッドコード、重複コード、複雑性、論理的冗長性、ドキュメントの不備、依存関係の問題

重大度レベル

重大度レベルは、コード品質検出の潜在的な影響または緊急性を示すために使用されます。 ユーザーが修復作業に優先順位を付け、利害関係者にリスクを伝えるのに役立ちます。 重大度は、 CodeQL および業界標準の規則に従って、問題を検出したルールによって決定されます。

Severity	Definition
エラー	バグ、障害、または主要な保守容易性リスクを引き起こす可能性が高い重大度の問題を示します。
警告	コードの品質や信頼性に影響を与える可能性があるが、すぐには重要ではない中程度の重大度の問題を示します。
注	重大度の低い問題、軽微な改善、または推奨事項を示します。 これらの結果は、継続的なコードの正常性と保守容易性に役立ちます。

評価の定義

これらの評価は、完全な既定のブランチのスキャンによって検出されたルールベースの結果の重大度に基づいて、リポジトリの全体的な信頼性と保守性 CodeQL 要約するために使用されます。

Rating	Definition	条件 (結果に基づく)
Excellent (非常に良い)	コードベースは、信頼性と保守容易性に関するベスト プラクティスを示しています。	コード品質の結果が検出されない
Good (適切)	コードベースには軽微な問題があるか、改善が推奨されます。	"注"レベルの結果が1件以上
Fair (普通)	コードベースには、品質に影響を与える可能性があるが重要ではない中程度の重大度の問題があります。	≥1 "警告" レベルの指摘
改善が必要	コードベースには、バグや主要な保守容易性リスクなど、重大度の高い問題があります。	≥1 "エラー" レベルの検出

詳細については、次を参照してください。

• GitHubのコード品質について
• リポジトリのコード品質結果の解釈