GitHub - Copilotのソースを表示

== 概要 ==
GitHub Copilotは、GitHubとOpenAIが共同開発したAI駆動のコード支援ツールである。<br>
エディタ内でリアルタイムにコードの提案・補完・生成を行い、開発者の生産性を向上させる。<br>
<br>
会話型インターフェース (Copilot Chat)、自律的なコード実装 (Agent Mode)、CLIサポート等、コーディング作業のあらゆる場面をカバーする機能を提供する。<br>
<br>
特に強力なサポートを提供するプログラミング言語は以下の通りである。<br>
* Python
* JavaScript / TypeScript
* Ruby
* Go
* C# / C++
<br>
対応IDEは以下の通りである。<br>
* VS Code
* Visual Studio
* JetBrains IDE
*: IntelliJ IDEA、PyCharm、WebStorm等
* Neovim
* Xcode
* Eclipse
<br><br>

== プラン ==
==== プランの種類 ====
GitHub Copilotは個人・組織の規模や用途に応じて複数のプランが提供されている。<br>
<br>
<center>
{| class="wikitable"
|+ GitHub Copilot プラン比較
! プラン !! 月額料金 !! 主な機能・制限
|-
| Free || 無料 || コード補完: 2,000回/月<br>Copilot Chat: 50メッセージ/月<br>基本的なコード提案
|-
| Pro || $10/ユーザ || コード補完: 無制限<br>Copilot Chat: 無制限<br>Code Review対応
|-
| Pro+ || $39/ユーザ || Proの全機能<br>プレミアムリクエスト: 1,500回/月<br>Coding Agent対応<br>最新モデルへの優先アクセス
|-
| Business || $19/ユーザ || Pro相当の機能<br>組織管理機能<br>コンテンツ除外設定<br>プロンプト・提案の非保持
|-
| Enterprise || $39/ユーザ || Businessの全機能<br>Coding Agent対応<br>カスタムモデル対応<br>高度なセキュリティ管理
|}
</center>
<br>
==== 学生向けプラン ====
GitHub Student Developer Packに登録している学生は、GitHub Copilotを無料で利用できる。<br>
<br>
提供内容はProプランと同等であり、コード補完やCopilot Chatが無制限で使用可能である。<br>
<br>
申請はGitHubの学生認証ページから行い、在学証明が必要となる。<br>
<br><br>

== コード補完 ==
==== インラインコード提案 ====
コード補完機能はエディタ内でリアルタイムに動作して、入力中のコードに対して続きを提案する。<br>
<br>
提案はグレイテキスト (ゴースト表示) でインライン表示され、開発者はそのまま受け入れるか却下するかを選択できる。<br>
<br>
提案の対象範囲は単一の記号から複数行にわたるブロックまで柔軟に対応する。<br>
コメントや関数シグネチャを記述するだけで、実装コード全体が提案されることもある。<br>
<br>
==== 複数行補完 ====
Copilotは関数、クラス、テストケース等、複数行に渡るコードブロック全体を一括で提案できる。<br>
<br>
この機能は、以下に示すような場面で有効である。<br>
* 関数のコメント (docstring) から実装コードを生成する。
* テストファイルでテストケースの雛型を一括生成する。
* 定型的なボイラープレートコードを自動補完する。
<br>
Next Edit Suggestions機能 (VS Code等でプレビュー提供) では、直前の編集内容をもとに、次に修正すべき箇所の提案も行う。<br>
<br>
==== 提案の操作 ====
下表に、提案を操作するキーボードショートカットを示す。<br>
<br>
<center>
{| class="wikitable"
|+ コード補完 操作一覧
! 操作 !! キー !! 説明
|-
| 提案を受け入れる || [Tab]キー || 現在表示されている提案を全て適用する。
|-
| 提案を却下する || [Esc]キー || 現在の提案を非表示にする。
|-
| 次の提案へ切り替える || [Alt] + <nowiki>]</nowiki>キー || 複数ある提案の中で次の候補を表示する。
|-
| 前の提案へ切り替える || [Alt] + <nowiki>[</nowiki>キー || 複数ある提案の中で前の候補を表示する。
|-
| 単語単位で受け入れる || [Ctrl] + [→]キー || 提案を1単語ずつ受け入れる。(VS Code)
|}
</center>
<br><br>

== Copilot Chat ==
==== Copilot Chatとは ====
Copilot Chatは、コードについて自然言語で会話できるインターフェースである。<br>
<br>
IDE内のチャットパネル、GitHub.com上のWebインターフェース、モバイルアプリから利用できる。<br>
<br>
マルチモーダル対応により、テキストに加えて音声での入力も可能である。<br>
コードスニペット、エラーメッセージ、スクリーンショットを貼り付けて質問することもできる。<br>
<br>
==== チャットコンテキスト ====
Copilot Chatでは、チャット入力時に <code>@</code> 記号を使用してコンテキストを指定できる。<br>
<br>
* <code>@workspace</code>
*: 現在開いているワークスペース全体をコンテキストとして参照する。
*: プロジェクト全体に関わる質問や、複数ファイルにまたがる処理の相談に有効である。
* <code>@terminal</code>
*: ターミナルの出力内容やエラーをコンテキストとして参照する。
*: コマンドのエラー解決や、ビルドログの分析に使用する。
* <code>@github</code>
*: GitHub上のIssue、PR、コミット情報をコンテキストとして参照する。
*: リポジトリの履歴や議論の内容をもとにした回答が得られる。
<br>
また、<code>#file</code>, <code>#folder</code>, <code>#symbol</code> を使って特定のファイル・フォルダ・シンボルをピンポイントで参照することもできる。<br>
<br>
==== スラッシュコマンド ====
チャット入力欄では、<code>/</code> で始まるスラッシュコマンドを使用して特定の操作を素早く実行できる。<br>
<br>
<center>
{| class="wikitable"
|+ Copilot Chat スラッシュコマンド一覧
! コマンド !! 説明
|-
| <code>/explain</code> || 選択したコードや指定したコードの動作・意図を自然言語で説明する。
|-
| <code>/fix</code> || 選択したコードのバグや問題点を検出して、修正案を提示する。
|-
| <code>/tests</code> || 選択したコードに対するユニットテストを生成する。
|-
| <code>/doc</code> || 選択したコードのドキュメントコメント (docstring等) を生成する。
|-
| <code>/clear</code> || チャット履歴をクリアして新しい会話を開始する。
|}
</center>
<br><br>

== Agent Mode ==
==== Agent Modeとは ====
Agent Modeは2025年に導入された機能であり、Copilotが自律的にコードの実装、修正、検証を行うモードである。<br>
<br>
従来のコード補完およびチャットが人間の指示に対して1ステップで応答するのに対して、Agent Modeは複数のステップを自律的に実行して複雑なタスクを完遂する。<br>
<br>
複数ファイルにわたるコード変更、ターミナルコマンドの実行、エラーの自動修正ループ等を一連の処理として実施する。<br>
<br>
==== 動作フロー ====
Agent Modeは以下に示すフローで動作する。<br>
<br>
# コンテキストの特定
#: タスクに関連するファイルや依存関係を自動的に特定する。
# ファイルの読み取り
#: 関連ファイルの内容を読み込み、現在の実装状況を把握する。
# コードの変更
#: 必要な変更を複数ファイルに渡って実施する。
# ターミナルコマンドの実行
#: ビルド、テスト、依存パッケージのインストール等のコマンドを実行する。
# エラーの監視
#: 実行結果を監視して、エラーが発生した場合は原因を分析する。
# 自動修正
#: 検出したエラーを自動的に修正して、再度検証を行う。
<br>
このループは、タスクが完了するまで繰り返し実行される。<br>
<br>
==== 対応IDE ====
Agent Modeが完全に対応しているIDEを以下に示す。<br>
<br>
* VS Code (完全対応、推奨)
* Visual Studio
* JetBrains IDE (対応範囲は順次拡大中)
<br><br>

== Copilot Coding Agent ==
==== Coding Agentとは ====
<u>Copilot Coding Agentは、GitHubがホストするAIエージェントであり、GitHub Issue の内容をもとに実装を自動的に行う機能である。</u><br>
<br>
開発者がIssueにCopilotをアサインするだけで、エージェントが実装、テスト、ドラフトPRの作成までを自動的に完了する。<br>
<br>
この機能はPro+プランおよびEnterpriseプランで利用できる。<br>
<br>
==== 起動方法 ====
Coding Agentを起動する手順は以下の通りである。<br>
<br>
# GitHubリポジトリ上でIssueを開く。
# Issueの右サイドバーにある[Assignees]セクションを開く。
# アサイン先として[Copilot]を選択する。
# Copilotがタスクを受け付け、自動的に実装を開始する。
<br>
実装が完了すると、ドラフトPRが自動的に作成される。<br>
開発者はドラフトPRを確認して、内容をレビューした上でマージ操作を行う。<br>
<br>
==== セッションログ ====
Coding Agentが実行する全ての処理は、セッションログとして記録される。<br>
<br>
* 実施したファイル変更の一覧
* 実行したターミナルコマンドとその出力
* 判断の根拠や思考プロセスの説明
<br>
開発者はセッションログをPR画面から参照でき、エージェントの動作を透明性高く追跡できる。<br>
<br><br>

== Copilot CLI ==
==== gh copilot suggest ====
<code>gh copilot suggest</code> コマンドは、自然言語で説明したタスクに対して、実行すべきシェルコマンドを提案する機能である。<br>
<br>
基本的な使用方法を以下に示す。<br>
<br>
 gh copilot suggest "<タスクの説明>"
<br>
使用例を以下に示す。<br>
<br>
 # Dockerコンテナの一覧を確認するコマンドを提案させる例
 gh copilot suggest "実行中のDockerコンテナを一覧表示したい"
 
 # ファイル圧縮のコマンドを提案させる例
 gh copilot suggest "特定のディレクトリをtar.gzで圧縮したい"
<br>
==== gh copilot explain ====
<code>gh copilot explain</code> コマンドは、指定したシェルコマンドの動作・意味を自然言語で説明する機能である。<br>
<br>
基本的な使用方法を以下に示す。<br>
<br>
 gh copilot explain "<コマンド>"
<br>
使用例を以下に示す。<br>
<br>
 # コマンドの意味を説明させる例
 gh copilot explain "grep -rn 'pattern' ./src --include='*.ts'"
 
 # パイプラインの説明をさせる例
 gh copilot explain "find . -name '*.log' | xargs rm -f"
<br>
==== エイリアス ====
頻繁に使用するコマンドのために、短縮エイリアスが提供されている。<br>
<br>
<center>
{| class="wikitable"
|+ Copilot CLI エイリアス一覧
! エイリアス !! 展開されるコマンド !! 説明
|-
| <code>ghcs</code> || <code>gh copilot suggest</code> || コマンド提案の短縮形
|-
| <code>ghce</code> || <code>gh copilot explain</code> || コマンド説明の短縮形
|}
</center>
<br>
エイリアスはシェルの設定ファイルに追加 あるいは <code>gh copilot alias</code> コマンドで設定できる。<br>
<br><br>

== コードレビュー ==
==== Copilot Code Review ====
<u>Copilot Code Reviewは、Pull Requestに対してAIが自動的にコードレビューを行う機能である。</u><br>
<br>
人間のレビュアーが確認する前に、潜在的な問題点や改善点をコメントとして提示する。<br>
<br>
対応プランはProプラン以上であり、BusinessおよびEnterpriseプランでも利用可能である。<br>
<br>
==== レビュー対象 ====
下表に、Copilot Code Reviewが検出する問題のカテゴリを示す。<br>
<br>
<center>
{| class="wikitable"
|+ コードスキャンの検出カテゴリ一覧
|-
! カテゴリ !! 説明
|-
| バグ || ロジックエラー、境界値問題、未処理の例外等、実行時に問題を引き起こす可能性のあるコードを検出する。
|-
| セキュリティ || SQLインジェクション、XSS、ハードコードされた認証情報等、セキュリティ上の脆弱性を検出する。
|-
| パフォーマンス || 非効率なループ、不要なデータベースクエリ、メモリリークの可能性があるコードを検出する。
|-
| ベストプラクティス || コーディング規約への準拠、命名規則、重複コードの排除等を提案する。
|}
</center>
<br>
==== 自動レビュー設定 ====
PRが作成されるたびに自動的にCopilotのレビューをリクエストする設定が可能である。<br>
<br>
設定手順は以下の通りである。<br>
<br>
# リポジトリの[Settings]を開く。
# [Branches]セクションで対象ブランチの保護ルールを選択または作成する。
# [Require reviewers]の設定で[Automatically request Copilot review]を有効にする。
<br>
<u>この設定を有効にすると、PRが作成・更新されるたびにCopilotが自動的にレビューを実施する。</u><br>
<br><br>

== カスタマイズ ==
==== カスタム指示 ====
リポジトリ固有のコーディング規約、スタイル、要件をCopilotに事前に指示するために、カスタム指示ファイルを作成できる。<br>
<br>
* ファイルの配置場所
*: <u>.github/copilot-instructions.md</u>
*: <br>
*: リポジトリのルートに配置する。
*: Markdown形式で記述する。
*: Copilotがコード生成、チャット応答を行う時に自動的に参照される。
<br>
記述例を以下に示す。<br>
<br>
 <syntaxhighlight lang="md">
 # Copilot Instructions
 
 ## コーディング規約
 - インデントはスペース3つを使用する
 - 変数名はcamelCaseを使用する
 - 関数には必ずJSDocコメントを記述する
 
 ## 使用技術スタック
 - フロントエンド: React + TypeScript
 - バックエンド: Node.js + Express
 - データベース: PostgreSQL
 </syntaxhighlight>
<br>
==== パス固有指示 ====
特定のファイルパターンに対してのみ適用される指示ファイルを作成できる。<br>
<br>
ファイル名の形式は <u>*.instructions.md</u> であり、対象パスのパターンをファイル内で指定する。<br>
<br>
 <syntaxhighlight lang="md">
 ---
 applyTo: "src/components/**"
 ---
 
 ## Reactコンポーネント向け指示
 - 関数コンポーネントのみを使用する
 - Propsは必ずTypeScriptのinterfaceで型定義する
 - コンポーネントファイル内にスタイルを記述しない
 </syntaxhighlight>
<br>
==== コンテンツ除外設定 ====
特定のファイルおよびディレクトリをCopilotの参照対象から除外する設定が可能である。<br>
<br>
Business / Enterpriseプランでは、リポジトリ管理者がコンテンツ除外設定を行える。<br>
<br>
除外設定の主な用途は以下の通りである。<br>
* 機密情報を含む設定ファイルの除外
* ライセンスの異なるサードパーティコードの除外
* テストデータや個人情報を含むファイルの除外
<br>
==== MCP統合 ====
GitHub CopilotはModel Context Protocol (MCP) をサポートしており、外部ツールやデータソースとの統合が可能である。<br>
<br>
MCPとは、AIアシスタントが外部のシステム、データベース、APIと標準化された方法で連携するためのプロトコルである。<br>
<br>
MCPサーバの種類は以下の通りである。<br>
<br>
* Local / STDIO
*: ローカルマシン上で動作するMCPサーバ
*: 標準入出力 (stdio) を通じてCopilotと通信する。
* HTTP / SSE
*: HTTPエンドポイント または Server-Sent Events (SSE) 経由で通信するMCPサーバ
*: リモートサービスや内部システムとの連携に使用する。
<br>
GitHub公式のMCP Serverも提供されており、GitHub上のIssue、PR、リポジトリ情報に直接アクセスできる。<br>
<br>
MCPを活用することにより、Copilotはデータベース、社内API、独自のドキュメントシステム等を参照した回答を生成できるようになる。<br>
<br><br>

== セキュリティとプライバシー ==
==== データ保持ポリシー ====
下表に、GitHub Copilotのプランごとのデータ保持ポリシーを示す。<br>
<br>
<center>
{| class="wikitable"
|+ データ保持ポリシー一覧
! プラン !! プロンプトの保持 !! 提案の保持 !! 学習への使用
|-
| Free / Pro / Pro+ || GitHubのポリシーに準拠 || GitHubのポリシーに準拠 || ユーザ設定による
|-
| Business || 保持しない || 保持しない || 使用しない
|-
| Enterprise || 保持しない || 保持しない || 使用しない
|}
</center>
<br>
BusinessおよびEnterpriseプランでは、入力したプロンプトと生成された提案はGitHubのサーバに保持されず、モデルの学習にも使用されない。<br>
<br>
==== Public Code Filter ====
Public Code Filterは、公開リポジトリのコードと類似した内容の提案をブロックする機能である。<br>
<br>
この機能を有効にすると、GitHubに公開されているコードと一定以上類似するコードブロックは提案されない。<br>
<br>
設定はGitHubのCopilot設定ページから変更できる。<br>
<br>
* 有効 (推奨)
*: 公開コードとの類似提案を除外する。
* 無効
*: 全ての提案を表示する。(デフォルト: 有効)
<br>
==== IP保護 ====
GitHubはCopilot Enterpriseプランのユーザを対象に、著作権侵害に関するIP保護および免責保証を提供している。<br>
<br>
主な保護内容は以下の通りである。<br>
* Copilotが生成したコードによる著作権侵害訴訟に対する費用の補償
* プライベートリポジトリのコードはモデルの学習に使用されない。
* 個人ユーザの入力データは他のユーザへの提案に使用されない。
<br><br>

== 推奨事項 ==
==== プロンプトの書き方 ====
Copilotから精度の高い提案を得るためのプロンプト作成のポイントを以下に示す。<br>
<br>
* 構造化して記述する、
*: タスクの目的、入力、出力、制約を明確に分けて記述する。
*: 箇条書きや番号付きリストを使用して、要件を整理する。
* 具体的な要件を記述する。
*: "ファイルを処理する関数" ではなく <u>"CSVファイルを読み込み、年齢列が18以上の行だけを返す関数"</u> のように具体的に記述する。
* タスクを分割する。
*: 複雑なタスクは複数の小さなタスクに分割して、段階的に実装を進める。
* コメントでプロンプトを記述する。
*: コードファイル内にコメントとして要件を記述し、コード補完の精度を向上させる。
<br>
==== コンテキストの提供 ====
Copilotはエディタで開いているファイルの内容をコンテキストとして参照する。<br>
<br>
* 隣接タブの活用
*: 関連するファイルを複数のタブで開いておくことで、Copilotが参照できるコンテキストが増加する。
*: 型定義ファイル、インターフェース定義、関連モジュールを開いておくと提案精度が向上する。
* ファイル参照の活用
*: Copilot Chatで <code>#file</code> を使用して、特定のファイルをピンポイントで参照する。
*: <code>#folder</code> でフォルダ全体を、<code>#symbol</code> で特定の関数やクラスを参照できる。
* ワークスペース参照
*: <code>@workspace</code> を使用してプロジェクト全体をコンテキストに含めることにより、プロジェクト構造を踏まえた提案が得られる。
<br><br>


{{#seo:
|title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki
|keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,電気回路,電子回路,基板,プリント基板
|description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報 | This page is {{PAGENAME}} in our wiki about electronic circuits and SUSE Linux
|image=/resources/assets/MochiuLogo_Single_Blue.png
}}

__FORCETOC__
[[カテゴリ:Git]]