メモ
GitHub Code Quality は現在 パブリック プレビュー にあり、変更される可能性があります。 パブリック プレビュー の間、Code Quality は課金されませんが、Code Quality スキャンでは GitHub Actions 分が消費されます。
イントロダクション
このチュートリアルでは、 GitHub Code Quality を使用して、リポジトリ全体のコード正常性の問題を確認、優先順位付け、修復する方法について説明します。これにより、技術的負債を体系的に削減し、信頼性と保守性を向上させ、利害関係者に影響を伝えることができます。
[前提条件]
- Code Quality がリポジトリで有効です。 「GitHub Code Qualityの有効化」を参照してください。
- GitHub Code Quality を初めて有効にする際は、まず有効化してから既定のブランチで完全な CodeQL スキャンが完了するまで数分待っていることを確認してください。
1. リポジトリの全体的なコード正常性を評価する
-
リポジトリの [セキュリティ] タブに移動し、"コードの品質" の下の 標準の結果 をクリックします。
-
"標準の結果" ダッシュボードの概要では、現在の既定のブランチの状態をすぐに評価できます。
-
**保守容易性の評価** には、デッド コード、重複、複雑さ、不足しているドキュメント、ベスト プラクティスに従わない場合の結果の存在と重大度が反映されます。 -
**信頼性評価** は、コードの正確性、パフォーマンス、エラー処理、コンカレンシー、アクセシビリティに関する結果の存在と重大度を反映します。
-
2. 最も影響の大きい調査結果を特定し、優先順位を付ける
"標準の結果" ビューでは、Code Qualityによるリポジトリのデフォルトブランチの最新スキャン結果が表示されます。 これらの結果は次のとおりです。
-
**ルール**別にグループ化されているため、コードベースに最も影響を与える問題の種類を確認できます。 -
**重大度**レベル ("Error"、"Warning"、"Note") が割り当てられます。
重大度の高い結果に焦点を当てる
ダッシュボード フィルター を使用して、最も重大度の高い結果 ("エラー") に注目し、最も多くの問題を生成するルールを確認します。
リポジトリの保守性または信頼性の評価を向上させるには、そのメトリックの重大度レベルが最も高いすべての結果を解決 (修正または無視) する必要があります。
たとえば、リポジトリの "信頼性" メトリックを Needs improvement から Fair に改善するには、信頼性に影響するすべての エラー レベルの結果 に対処して解決する必要があります。 エラー レベルの結果が 1 つ以上ある場合、評価を "改善が必要" より高くすることはできません。 「メトリックと評価のリファレンス」を参照してください。
3. 調査結果のグループを調査し、コンテキストを理解する
対処する複数の結果を含むルールを特定したら、さらに調査して、基になる問題を理解できます。
-
ルール名をクリックすると、そのルールのすべての結果の詳細ビューが表示されます。
-
[ 詳細を表示] をクリックし、ルールの説明、推奨される修正プログラム、コード例と参照のサポートを確認します。
4. 修復オプションを選択する
強調表示されているすべての結果を評価して、有効性、影響、およびリスクを確認します。 品質の評価を向上させるには、修正または無視するかを選択することで、各指摘事項を解決する必要です。
自動修正を生成する
結果が有効で、コードベースに関連しているように見える場合は、推奨される修正プログラムを生成できます。
-
個々の検索結果の右側にある 修正を生成 をクリックします。
-
提案された変更の相違を慎重に確認し、それに同意する場合は、[ プル要求を開く] をクリックします。
-
[Commit autofix to branch](自動修正をブランチにコミットする) ダイアログ ボックスで、[Open a pull request](pull request を開く) を選択し、[ 変更のコミット] をクリックします。
ヒント
現時点では、結果のグループの自動修正を一括で生成することはできません。
1 つの pull request で複数の結果に対処する場合は、上記の手順 1 と 2 を繰り返します。次に、[Commit autofix to branch](自動修正をブランチにコミットする) ダイアログ ボックスで、最初の自動修正に既に作成したブランチ名を使用して、[Open pull request](pull request を開く) と [変更のコミット] を選択します。
修正は、ブランチの既存のドラフト pull request に追加されます。
-
準備ができたら、pull request の状態を "Draft" から "Ready for review" に変更し、提案された変更を慎重に確認します。 プル要求をマージする前に、CI チェックと自動テストが完了して合格するまで待ちます。
結果を無視する
データ再利用可能なコード品質.的外れな所見を無視する %}
- 検索結果を閉じるには、[ をクリックします。
- 結果は、開いている結果の一覧から消えます。 閉じられた結果は、ページの上部にある [無視済み] タブから確認して再度開くことができます。
5. 改善を測定し、影響を伝える
修復作業が完了したら、"標準の結果" ダッシュボードに戻り、更新された信頼性と保守容易性のメトリックを確認します。
関係者に影響を伝えるときは、次の点を強調します。
- "信頼性" または "保守容易性" に関する調査結果の数の 削減。
- 信頼性または保守容易性の 評価の変更 。
- 評価の変更を達成するために満たされている要件。 たとえば、"警告" レベルのすべての結果を修復すると、評価が "Fair" から "Good" に変わります。
品質評価の改善と結果の数の削減を使用して、進捗状況を示します。
6. pull request にコード品質標準を適用する
まだ行っていない場合は、プル要求の品質しきい値を設定して、コードベースの正常性を低下させるコードベースへの変更をブロックします。 「プル要求のコード品質しきい値の設定」を参照してください。
次のステップ
- 最近変更されたファイルの結果を修正することで、技術的負債をさらに削減します。 「最近マージされたコードの品質をAIで改善する」を参照してください。
-
[コミュニティ ディスカッション](https://github.com/orgs/community/discussions/177488)で GitHub Code Quality に関するフィードバックを提供します。