リポジトリバックログのコード品質の結果を修正する

ヒント

Code Qualityを初めて使用する場合は、リポジトリの品質スコアの確認と改善に関するガイド付きチュートリアルについては、AUTOTITLE を参照してください。

既定のブランチでの Code Quality の仕組み

Code Qualityは、既定のブランチをスキャンし、リポジトリの [コードの品質] タブの [ Security and quality] ページで結果を報告します。 2 種類の分析を実行します。

** 標準の結果 **: Code Quality では、 CodeQL を使用して、既定のブランチの決定論的なルールベースのスキャンを実行します。検索はルールと言語によってグループ化され、重大度 (エラー、警告、注) でラベル付けされ、それぞれに推奨される自動修正が含まれています。
** AI の結果 **: Code Quality は、AI を利用した分析を使用して、既定のブランチに最近プッシュされたファイルの品質の問題を特定します。これには、ベストプラクティス、名前付け規則、設計上の考慮事項など、ルールベースの分析で検出されない可能性がある問題が含まれます。

メモ

最近変更されたファイルの [AI の結果] ページは現在パブリックプレビューされており、変更される可能性があります。

結果を個別に解決したり、複数の結果を Copilotに割り当てたりすることができます。

リポジトリの [ Security and quality ] タブに移動します。
クリックして コードの品質 を展開し、標準の結果 をクリックします。
ダッシュボードフィルターを使用して、品質スコアに影響を与える可能性が最も高い結果に注目します。たとえば、「信頼性」の「エラー」レベルの検出結果をすべて表示するには、フィルターを次のように設定します。

is:open category:reliability severity:error
結果はルール別にグループ化されます。ルール名をクリックすると、そのルールのすべての結果の詳細ビューが表示されます。
[ 詳細を表示] をクリックし、ルールの説明、推奨される修正プログラム、コード例と参照のサポートを確認します。

コード品質ルールの結果を示すスクリーンショット。 "詳細を表示" というテキストが濃いオレンジ色で強調表示されています。

個々の検出結果の右側にある修正を生成をクリックします。
提案された変更の相違を確認します。同意する場合は、[ pull request を開く] をクリックします。
[Commit autofix to branch](自動修正をブランチにコミットする) ダイアログで、[Open a pull request](pull request を開く) を選択し、[ 変更のコミット] をクリックします。
自動修正 pull request がレビューの準備ができたら、その状態を "Draft" から "Ready for review" に変更し、CI チェックが成功するのを待ってからマージします。
または、検索結果が関連しない場合や操作可能でない場合は、[ 閉じる] をクリックします。たとえば、もはや保守されていないレガシーコード内の検出結果であったり、チームのコーディング標準における既知の例外であったり、実際には品質リスクをもたらさない誤検知であったりする場合、その検出結果を却下することがあります。

保守容易性または信頼性スコアを上げるには、そのメトリックに現在影響を与えている最も高い重大度レベルですべての結果を解決する必要があります。「メトリックとスコアのリファレンス」を参照してください。