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

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

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

1. ** 標準の結果 **: Code Quality では、 CodeQL を使用して、既定のブランチの決定論的なルールベースのスキャンを実行します。 検索はルールと言語によってグループ化され、重大度 (エラー、 警告、 注) でラベル付けされ、それぞれに推奨される自動修正が含まれています。

2. ** AI の結果 **: Code Quality は、AI を利用した分析を使用して、既定のブランチに最近プッシュされたファイルの品質の問題を特定します。これには、ベスト プラクティス、名前付け規則、設計上の考慮事項など、ルールベースの分析で検出されない可能性がある問題が含まれます。

AI の結果の解決については、最近マージされたファイルのコード品質の結果を修正する を参照してください。

標準の結果の解決

1. リポジトリの [ Security and quality ] タブに移動します。

2. クリックして コードの品質 を展開し、標準の結果 をクリックします。

3. ダッシュボード フィルターを使用して、品質スコアに影響を与える可能性が最も高い結果に注目します。 たとえば、「信頼性」の「エラー」レベルの検出結果をすべて表示するには、フィルターを次のように設定します。

   is:open category:reliability severity:error

4. 結果はルール別にグループ化されます。 ルール名をクリックすると、そのルールのすべての結果の詳細ビューが表示されます。

   

5. [ 詳細を表示] をクリックし、ルールの説明、推奨される修正プログラム、コード例と参照のサポートを確認します。

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

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

コード品質スコアが更新されたことを確認する

自動修正プル要求がマージされたら、"標準の結果" ビューに戻り、次の点を確認します。

• 結果の数が減少しました。
• そのメトリックの現在の最小重大度レベルですべての結果を解決した場合、保守容易性または信頼性スコアが向上しました。

次のステップ

• 最近マージされたファイルのコード品質の結果を修正する