テクノロジー 注目度 90

Visual Studio Code: GitHub Copilot の .github フォルダ仕様

Visual Studio Code で GitHub Copilot を使用する場合に、プロジェクト固有のルールやコンテキストを自動的に適用するための `.github` フォルダの仕様について解説するドキュメントです。

このドキュメントでは、`.github` フォルダ内の各設定ファイル(`copilot-instructions.md`、`instructions/*.md`、`prompts/*.prompt.md`、`agents/*.md`、`skills/*/SKILL.md`)の役割、構成、プロパティなどを詳細に説明しています。

例えば、`copilot-instructions.md` はリポジトリ全体に適用されるルールを定義し、`instructions/*.md` は特定のファイル形式やディレクトリに対して適用されるルールを定義します。また、`prompts/*.prompt.md` はユーザーが / コマンド で呼び出す定型タスクのテンプレートであり、`agents/*.md` は特定の専門知識を持つペルソナを定義し、`skills/*/SKILL.md` はAI が必要だと判断した時に自動ロードされる専門知識・ツール群を定義します。

このドキュメントは、GitHub Copilot を効果的に活用するために必要な `.github` フォルダの設定方法を理解する上で役立ちます。


背景

Visual Studio Code と GitHub Copilot の連携において、プロジェクト固有のルールやコンテキストを自動的に適用するための `.github` フォルダが重要です。このドキュメントは、その `.github` フォルダの仕様と各設定ファイルの詳細な解説を提供しています。

重要用語解説

GitHub Copilot: GitHub が提供する AI 搭載のコード補完ツール。開発者の作業効率を向上させるために、コード生成や提案を行う。

[重要性]:Visual Studio Code と連携して使用され、開発プロセスに大きな影響を与える。

[具体例(あれば)]:関数定義の自動化、コードのバグ修正提案など。

.github フォルダ: Visual Studio Code で GitHub Copilot を使用する場合に、プロジェクト固有のルールやコンテキストを定義するためのフォルダ。

[重要性]:GitHub Copilot の動作をカスタマイズし、開発環境を最適化するために不可欠である。

[具体例(あれば)]:リポジトリ全体のルール、特定のファイル形式に対するルールなどを設定する。

copilot-instructions.md: `.github` フォルダ内のファイルで、リポジトリ全体に適用される基本的なルールやコンテキストを定義する。

[重要性]:GitHub Copilot の動作の基本となる設定であり、開発環境全体の基盤となる。

[具体例(あれば)]:コードスタイルガイド、禁止事項などを記述する。

instructions/*.md: `.github` フォルダ内のファイルで、特定のディレクトリやファイル形式に適用されるルールを定義する。

[重要性]:プロジェクト固有のルールを細かく設定し、開発環境をより効率的にすることができる。

[具体例(あれば)]:特定の言語に対するコードスタイルガイドなどを記述する。

今後の影響

このドキュメントは、Visual Studio Code と GitHub Copilot を使用している開発者に役立ちます。 `.github` フォルダの設定方法を理解することで、GitHub Copilot の機能を最大限に活用し、開発効率を向上させることができます。また、プロジェクト固有のルールやコンテキストを定義することで、コード品質の向上とチームワークの促進にも貢献します。