GitHubは、「GitHub Copilot」の「カスタム指示」に関するTipsを公式ブログで紹介した。開発者が望むコードを効率的かつ安全に得られるよう支援するのが狙いだ。
この記事は会員限定です。会員登録(無料)すると全てご覧いただけます。
GitHubは2025年9月3日(米国時間)、AI(人工知能)コーディングアシスタント「GitHub Copilot」(以下、Copilot)の「カスタム指示」(カスタムインストラクション)に関するTipsをブログで公開した。Copilotは自然言語で与えるプロンプト次第で出力の品質が大きく変わるため、GitHubは「ポイントを押さえたカスタム指示を作成しておくことで効率的なコードを生成できる」としている。
カスタム指示とは、いわゆる「システムプロンプト」のようなもので、Copilotの挙動を開発者のニーズやプロジェクト固有のルールに合わせて調整するための機能だ。「アプリケーションの目的」「技術スタックの内容」「コーディングのルール」といった内容をカスタム指示として与えることで、Copilotに開発者の意図やプロジェクトの背景を理解させ、それに沿った提案をさせられるようになるという。
GitHubは、カスタム指示を「copilot-instructions.md」ファイルに記載することを推奨している。本稿では、Copilotに適切な提案をさせるためにカスタム指示ファイルに記載すべき5つのポイントを紹介する。
プロジェクトの概要を記載する。プロジェクトで開発するアプリケーションの目的は何か、対象ユーザーは誰か、主な機能はどんなものかを簡潔に説明する。長文である必要はなく、数行でプロジェクトの全体像を示すことができれば十分だ。
バックエンドやフロントエンドで使っている技術、例えばAPIやデータベース、テストツールなどを列挙することで、Copilotはプロジェクトの技術的な背景を理解しやすくなる。詳細な情報を何段落にもわたって書く必要はない。以下は一例だ。
プロジェクトで定めたコーディング規約や付随するルールをCopilotに伝える。「JavaScriptやTypeScriptではセミコロンを入れるのか?」「Pythonでは型ヒントを使用するのか?」「インデントにタブとスペースのどちらを使うか?」といったプロジェクト共通のルールを明示することで、Copilotが生成するコードの品質や一貫性を保つことができる。
ディレクトリ構造を記載することで、Copilotに無駄な作業をさせずに済む。以下が記述例だ。
セットアップやビルド、テストに使うスクリプトや開発支援ツールの存在をCopilotに伝える。これによって、Copilotが既存のツールを活用した上で精度の高い提案を迅速に提案できるようになる。以下が記述例だ。
Copilot自身にカスタム指示ファイルを生成させる方法もある。まずCopilotにプロンプトで指示を与え、たたき台となるファイルを生成させる。それを開発チームが編集して利用するという方法になる。
以下はカスタム指示ファイルを生成するプロンプトの例だ。
Q: カスタム指示とは何か?
A: Copilotの挙動をプロジェクト固有のルールや開発者のニーズに合わせて調整する仕組みで、プロジェクトの背景を理解させ、意図に沿ったコードを提案させるためのもの。GitHubは「copilot-instructions.md」に記載することを推奨している。
Q: GitHubが示したカスタム指示に盛り込むべき5つのポイントは?
A: 「プロジェクト概要の記載」「技術スタックの明確化」「コーディングガイドライン」「プロジェクト構造の説明」「利用可能なリソースやスクリプトの明示」。
Q: Copilotにカスタム指示を作らせる活用法もあるか?
A: ある。Copilotにたたき台となるカスタム指示ファイルを生成させ、開発チームが編集して利用する方法も紹介されている。
Copyright © ITmedia, Inc. All Rights Reserved.
本記事は制作段階でChatGPT等の生成系AIサービスを利用していますが、文責は編集部に帰属します。