GitHub Copilot のプロンプトエンジニアリングの覚え書き

2025/03/08・3 min read

目次

プロンプトのTips

高レベルの目標を設定する

​新しいファイルやコードベースが空の場合、最初に全体的な目標やシナリオを説明することで、GitHub Copilot に意図を伝えやすくなります。

簡潔かつ具体的な指示を与える

​大きなタスクを細分化し、それぞれに対して明確な指示を出すことで、より正確なコード提案を得ることができます。​

実例を提供する

​入力データや期待する出力の具体例を示すことで、Copilot が意図を理解しやすくなります。

​取得したいデータの種類や処理方法、使用するAPIエンドポイントなど、詳細を具体的に記述することで、より正確なコード提案が得られます。

# OpenWeatherMap API を使用して、指定された都市の現在の天気情報を取得する関数を作成してください。
# - API エンドポイント: http://api.openweathermap.org/data/2.5/weather
# - HTTP メソッド: GET
# - パラメータ:
#   - q: 都市名
#   - appid: API キー
# - レスポンス形式: JSON
# - 必要な情報:
#   - 気温 (temperature)
#   - 湿度 (humidity)
#   - 天気の説明 (weather description)
# - エラーハンドリング:
#   - 無効な都市名が指定された場合、適切なエラーメッセージを表示する
# - 注意点:
#   - 気温はケルビンで提供されるため、摂氏に変換すること

関連するコードを提示する

GitHub Copilotは開いているタブ情報を認識するため、​関連するコードやファイルを開いておくことで、Copilot に追加のコンテキストを提供し、より適切な提案を引き出すことができます。 ​

適切なコーディングプラクティスに従う

変数名や関数名を意味のあるものにするなど、良いコーディング習慣を守ることで、Copilot の提案精度を向上させることができます。 ​

1発で100点を求めない

​最初のプロンプトで期待通りの結果が得られない場合、プロンプトを再構成し、試行錯誤を繰り返すことで、より良い結果を導くことができます。

参考情報