最近マージされたコードの品質をAIで改善する

メモ

GitHub Code Quality は現在パブリックプレビューにあり、変更される可能性があります。パブリックプレビューの間、Code Quality は課金されませんが、Code Quality スキャンでは GitHub Actions 分が消費されます。

イントロダクション

このチュートリアルでは、最近既定のブランチにマージされた、 Code Qualityの AI を利用したコード分析によって検出された品質の問題を調査し、修復する方法について説明します。

最近マージされたファイルの品質を向上させると、リポジトリ内の技術的負債が削減され、他の開発者がアクティブな開発中のファイルで作業しやすくなります。

          Code Quality には 2 つの防御線があります

          Code Quality は、品質の問題に関するプル要求とコメントをスキャンし、pull request がマージされた後に **2 回目の AI スキャンを実行** します。 2 種類のスキャンでは、補完的なテクノロジが使用されます。

* プル要求スキャンでは 、 CodeQL ルールを使用して問題を特定します。この分析は徹底的にテストされ、コードが品質規則と一致しない場所を特定するのに適しており、多くのファイルを分析できます。ただし、コーディング言語のサブセットがサポートされており、ルールがない問題を特定することはできません。

        **最近マージされたファイル スキャンでは** 、大規模な言語モデルを使用して、最近変更されたファイルを分析し、最大 5 ファイルの結果を報告します。 この分析では、ルールによって制限されることなく、すべての言語のコードを調べ、 CodeQL ルールが提供する内容を超えるコンテキスト分析情報と提案を提供します。

[前提条件]

        Code Quality が有効になっている場合は、 [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality) を参照してください。

        Code Qualityが有効になってから、少なくとも 1 つのプル要求がマージされています。

1. リポジトリの AI 提案を表示する

既定のブランチで最近マージされたファイルを Code Quality スキャンすると、 AI の結果 ビューに結果が表示され、最大 5 ファイルの結果が表示されます。

リポジトリの [ Security and quality ] タブに移動します。
クリックして コードの品質 を展開し、AI の結果 をクリックします。

メモ

リポジトリが非アクティブな場合、または LLM 分析で既定のブランチへの最近のプッシュでコード品質を向上させる方法を提案できなかった場合、このビューは空です。

2. リポジトリの推奨される改善点を確認する

          **
          AI の結果
          **ページには、各ファイルが特定された品質問題の数と、ファイルが既定のブランチにプッシュされた日時と共に一覧表示されます。

ファイル名をクリックすると、検出された品質の問題と推奨される修正プログラムの詳細が表示されます。

コード品質の "AI の結果" ビューのスクリーンショット。

3. 修復作業を委任するか、プル要求を自分で開く

プル要求を開いて、推奨される自動修正をファイルに適用したり、修復作業を Copilotクラウドエージェントに委任したりできます。 Copilotに作業を割り当てるには、Copilotクラウドエージェントライセンスが必要です。
サインアップ Copilot

作業を委任する Copilotクラウドエージェント

提案された変更をプロンプトとして使用して、プル要求を開いてファイルの改善を行うようにクラウドエージェントに依頼できます。提案された変更が気に入り、複数のファイルに修正を加えるプルリクエストを開きたい場合、これが最適なオプションです。

pull request の作成を委任するには:

        **複数のファイル:** 含めるファイルを選択したら、ファイル一覧のヘッダーで**Copilotに選択したものを割り当て**をクリックします。

ファイルが1つ: ファイルに[割り当て]をクリックします。

        クラウド エージェントが作業を設定している間、遅延が発生します。 pull request が開き、作業が進行中の場合は、pull request へのリンクを含むバナーが表示されます。

        Copilotクラウドエージェントの作業を追跡できます。

pull request では、作業の進行状況に応じて概要が更新されます。

        [エージェント ページ](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text)またはセッション ログの使用。 「[AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions)」を参照してください。

自分のプルリクエストを作成する

pull request を自分で開いて、自動修正候補を適用できます。これは、次の場合に最適なオプションです。

プル要求を開く前に、ローカルまたは GitHub Desktop で変更を処理する必要がある
にアクセスすることはできません。 Copilotクラウドエージェント

メモ

自分で pull request を開くと、修正をコミットできるファイルは一度に1つだけです。複数のファイルを一度に修正するには、 Copilotクラウドエージェントを使用する必要があります。

pull request を開く

ファイル名をクリックすると、検出された品質の問題の詳細が表示されます。
問題と推奨される修正プログラムを確認します。
[Copilotに割り当てる] ドロップダウンを展開し、[pull request を開く] をクリックして、既定のオプションを [プル要求を開く] に変更します。ユーザー設定が記憶されます。
[ pull request を開く ] をクリックして、コミットオプションのダイアログを開きます。
[ 変更のコミット] をクリックして、修正を含むプル要求を作成します。

4. コンテキストを持つ pull request レビュー担当者を提供する

コードの変更を提案する理由に関するコンテキストを提供することは、チームメンバーに pull request のレビューを促す最善の方法です。 Copilotクラウドエージェントを使用した場合、pull request の概要には、pull request によって修正された問題の詳細が既に含まれています。

          GitHub Code Quality ビューからプル要求を直接開いた場合、pull request の概要は "AI の結果" ビューにリンクされます。 
          AI の結果

ビューからプル要求の概要に説明の一部をコピーすることもできます。

GitHub Code Quality によって作成された pull request の概要のスクリーンショット。

5. 変更がAI の結果に与える影響を確認する

pull request をマージした後に "AI の結果" ビューに戻ると、修正した結果は一覧に表示されなくなります。

次のステップ

        Copilotクラウドエージェントが開発タスクの迅速化にどのように役立つかについて説明します。 「[AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results)」を参照してください。

        GitHub Code Qualityディスカッションで[](https://github.com/orgs/community/discussions/177488)に関するフィードバックを提供します。