メモ
GitHub Code Quality は現在 パブリック プレビュー にあり、変更される可能性があります。 パブリック プレビュー の間、Code Quality は課金されませんが、Code Quality スキャンでは GitHub Actions 分が消費されます。
イントロダクション
このチュートリアルでは、既定のブランチに最近マージされた Code Quality の AI 駆動コード分析が検出した品質の問題を確認し、修正する方法について説明します。
最近マージされたファイルの品質を向上させると、リポジトリ内の技術的負債が削減され、他の開発者がアクティブな開発中のファイルで作業しやすくなります。
Code Quality には 2 つの防衛線があります
Code Quality は、品質の問題に関するプル要求とコメントをスキャンし、pull request がマージされた後に 2 回目の AI スキャンを実行 します。 2 種類のスキャンでは、補完的なテクノロジが使用されます。
-
**pull request スキャン** は、CodeQL ルールを使用して、問題を特定します。 この分析は徹底的にテストされ、コードが品質規則と一致しない場所を特定するのに適しており、多くのファイルを分析できます。 ただし、コーディング言語のサブセットがサポートされており、ルールがない問題を特定することはできません。 -
**最近マージされたファイルのスキャン**は、大規模言語モデルを使用して、最近変更されたファイルを分析し、最大 5 ファイルの結果を報告します。 この分析では、ルールによって制限されることなく、すべての言語でコードを調査し、CodeQL ルールが提供するものを超えるコンテキスト分析情報と提案を提供します。
[前提条件]
- Code Quality が有効になっています。「GitHub Code Qualityの有効化」を参照してください。
- Code Quality が有効になってから、少なくとも 1 つのプル要求がマージされました。
1. リポジトリの AI 提案を表示する
既定のブランチに最近マージされたファイルの Code Quality スキャン後、[AI の結果] ビューで結果が表示されます。ここでは、最大 5 ファイルまでの結果が表示されます。
- リポジトリの [セキュリティ] タブに移動します。
- クリックして コードの品質 を展開し、AI の結果 をクリックします。
メモ
リポジトリが非アクティブな場合、または LLM 分析で既定のブランチへの最近のプッシュでコード品質を向上させる方法を提案できなかった場合、このビューは空です。
2. リポジトリの推奨される改善点を確認する
**AI の結果** ページには、各ファイルに、識別された品質問題の数と、ファイルが既定のブランチにプッシュされた日時が表示されます。
- ファイル名をクリックすると、検出された品質の問題と推奨される修正プログラムの詳細が表示されます。
3. 修復作業を委任するか、プル要求を自分で開く
プル要求を開いて、推奨される自動修正をファイルに適用するか、修復作業を Copilotコーディングエージェント に委任できます。 作業を Copilotコーディングエージェント に割り当てるには、Copilot ライセンスが必要です。
Copilot にサインアップする
作業を Copilotコーディングエージェント に委任する
コーディング エージェント に pull requests を開いて、プロンプトとして提案された変更を使用してファイルを改善するように依頼できます。 提案された変更が気に入り、複数のファイルに修正を加えるプルリクエストを開きたい場合、これが最適なオプションです。
pull request の作成を委任するには:
-
**複数のファイル:** 含めるファイルを選択し、その後、ファイル一覧のヘッダーにある **[選択した項目を Copilot に割り当てる]** をクリックします。 -
**1 つのファイル:** ファイルに対して **[Copilot に割り当てる]** をクリックします。
コーディング エージェント が作業を設定している間に、遅延が発生します。 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/coding-agent/track-copilot-sessions)」を参照してください。
自分のプルリクエストを作成する
pull request を自分で開いて、自動修正候補を適用できます。 これは、次の場合に最適なオプションです。
- pull request を開く前に、ローカルまたは GitHub Desktop で変更作業を行う場合
- Copilotコーディングエージェント へのアクセス権がありません
メモ
自分で pull request を開くと、修正をコミットできるファイルは一度に1つだけです。 一度に複数のファイルを修正するには、Copilotコーディングエージェント を使用する必要があります。
pull request を開く
-
ファイル名をクリックすると、検出された品質の問題の詳細が表示されます。
-
問題と推奨される修正プログラムを確認します。
-
[Copilot に割り当てる] ドロップダウンで、 [pull request を開く] をクリックし、既定のオプションを [pull request を開く] に変更します。 ユーザー設定が記憶されます。
-
[ pull request を開く ] をクリックして、コミット オプションのダイアログを開きます。
-
[ 変更のコミット] をクリックして、修正を含むプル要求を作成します。
4. コンテキストを持つ pull request レビュー担当者を提供する
コードの変更を提案する理由に関するコンテキストを提供することは、チーム メンバーに pull request のレビューを促す最善の方法です。 Copilotコーディングエージェント を使用している場合は、pull request の概要に、pull request が修正した問題の全容がすでに含まれています。
GitHub Code Quality ビューからプルリクエストを直接開くと、プルリクエストの概要は "AI の結果" ビューにリンクされます。 AI の結果 ビューの説明の一部をプル要求の概要にコピーしたい場合があります。
5. あなたの変更がAI の結果に影響を与えるのを確認してください。
pull request をマージした後に "AI の結果" ビューに戻ると、修正した結果は一覧に表示されなくなります。
次のステップ
- Copilotコーディングエージェント が、開発タスクの迅速化にどのように役立つかについて説明します。 「GitHub Copilot を使用してタスクに取り組むためのベスト プラクティス」を参照してください。
- コミュニティ ディスカッションで GitHub Code Quality に関するフィードバックを提供します。