リポジトリのコード品質結果の解釈

[前提条件]

• Code Quality が有効になっています。「GitHub Code Qualityの有効化」を参照してください。

コード品質の結果の完全なバックログの表示

1. リポジトリの [セキュリティ] タブに移動します。
2. クリックして コードの品質 を展開し、標準の結果 をクリックします。

または、最近変更されたファイルの AI を利用した結果を表示する場合は、 最近マージされたコードの品質をAIで改善する を参照してください。

リポジトリのバックログの探索

"標準の結果" ダッシュボードには、CodeQL 分析によってリポジトリのデフォルトブランチで検出されたすべての結果が表示されます。 このビューは、品質結果の完全なバックログを視覚化し、特定の種類の問題を修正するための作業に優先順位を付けるのに役立ちます。

ページの上部にある概要は、コードベースの保守性と信頼性をまとめたものです。

概要の下には、結果の完全な一覧がヘッダーと共に表示され、フィルターを使用して特定の結果セットに集中できます。 結果は次のとおりです。

• 各知見を検出したルールごとにグループ化
• 各ルール内で、ファイル パス順にアルファベット順に並べ替え

影響を受けるファイルを一覧表示するルールを展開し、ルールの名前をクリックして結果を確認し、結果の完全な詳細を表示します。

評価とメトリックの解釈

コード品質の結果は、常にリポジトリのコンテキストで解釈する必要があります。 例えば次が挙げられます。

• 小さなリポジトリ、またはサポートされている言語で記述されたコードの量が少ないリポジトリでは、結果が少なく、適切な評価が得られます。
• 生成されたコードが多いリポジトリには多くのメンテナンス結果が含まれる可能性があり、保守容易性の評価が下がる可能性があります。 ソース コード自体が保守可能な場合、これは問題になりません。
• 完全にサポートされている言語で多数のコードを含む大規模なリポジトリでは、多くの場合、コードの大部分に適切な保守性と信頼性の標準がある場合でも、多くの結果が得られます。

メトリックと評価の計算方法の詳細については、 メトリックと評価のリファレンス を参照してください。

次のステップ

• 既定のブランチで品質の結果を修復し、リポジトリの保守性と信頼性の評価を向上させます。 「リポジトリのコードの品質の向上」を参照してください。
• ルールセットを使用してプル要求の品質しきい値を設定することで、リポジトリでコード品質の問題が蓄積されないようにします。 「プル要求のコード品質しきい値の設定」を参照してください。