Skip to content

aktsmm/ghc_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

162 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Copilot Agent Workflow Template

License: CC BY-NC-SA 4.0

GitHub Copilot × VS Code でエージェントワークフローを構築するためのテンプレートリポジトリです。
エージェント定義・インストラクション・プロンプトのサンプルを収録しており、自分のプロジェクトにコピーしてすぐに使えます。

特徴

  • 📦 すぐ使えるサンプル — エージェント、インストラクション、プロンプトの実用的なテンプレート
  • 🎯 ベストプラクティス準拠 — Anthropic / OpenAI / Microsoft のガイドラインを参考に設計
  • 🔧 カスタマイズ可能 — プロジェクトに合わせて自由に拡張・変更可能
  • 📚 Skill 同梱 — エージェント設計の参照ガイド(agentic-workflow-guide)を含む

クイックスタート

# 1. テンプレートからリポジトリを作成(GitHub UI で「Use this template」)
# 2. または手動でクローン
git clone https://github.com/aktsmm/ghc_template.git

# 3. .github フォルダをプロジェクトにコピー
cp -r .github /path/to/your-project/

収録内容

パス 説明
.github/copilot-instructions.md 共有ガードレール(回答トーン、レビュー方針)
.github/agents/ エージェント定義(sample, orchestrator, sync-to-global, ghc-research
.github/agents_sync/ グローバル用エージェント(workflow-designer, DeepResearch
.github/instructions_sync/ グローバル用インストラクション(core/, dev/, integrations/
.github/prompts/ ワークスペース用プロンプト(create-workflow, sample
.github/prompts_sync/ グローバル用プロンプト(git操作、エクスポート、ふりかえり 等 16件)
.github/skills/ Copilot Skills(agentic-workflow-guide
AGENTS.md 登録済みエージェント・関連アセットの一覧(SSOT)
output_sessions/ セッションログ・作業記録の出力先(gitignore 対象)

使い方

1. エージェントを呼び出す

Copilot Chat で /agent コマンドを使用:

/agent sample          # サンプルエージェント
/agent orchestrator    # オーケストレーター
/agent ghc-research    # GitHub Copilot/VS Code 関連の調査

2. プロンプトを呼び出す

Copilot Chat で /prompt コマンドを使用:

# ワークスペース用
/prompt create-workflow              # ワークフロー作成
/prompt sample                       # プロンプト作成用テンプレート

# グローバルプロンプト(全ワークスペースで使用可能)
/prompt git-commit                   # Git コミット(Push なし)
/prompt git-commit-push              # Git コミット&プッシュ
/prompt git-pull                     # Git プル
/prompt debug-error                  # エラーデバッグ支援
/prompt write-tests                  # テストコード生成
/prompt review-agents-and-instructions  # エージェント・instructions レビュー
/prompt review-retrospective-learnings  # 学びを設計資産へ反映
/prompt export-session-log           # 汎用作業ログ(AI 可読・構造化)
/prompt export-copilot-session-dialogue  # セッション対話ログ・成果エクスポート
/prompt export-knowledge             # 知見エクスポート(ドメイン自動判定)
/prompt export-sync-to-public-skills # 知見を公開スキルリポジトリに反映
/prompt wrap-up-work                 # セッション終了時クリーンアップ
/prompt convert-to-tweet              # セッション内容を X ポスト用に変換
/prompt refactor-context             # コンテキスト最適化(instructions 等)

3. 新しいエージェントを作成する

# サンプルをコピーして編集
cp .github/agents/sample.agent.md .github/agents/my-agent.agent.md

# AGENTS.md に追記

ファイル構成

.github/
├── copilot-instructions.md    # Copilot 共通設定
├── agents/                    # エージェント定義
│   ├── sample.agent.md        # テンプレート
│   ├── orchestrator.agent.md  # オーケストレーター例
│   ├── sync-to-global.agent.md
│   └── ghc-research.agent.md
├── agents_sync/               # グローバル用エージェント
│   ├── workflow-designer.agent.md
│   └── DeepResearch.agent.md
├── instructions_sync/         # グローバル用インストラクション
│   ├── core/                  # セキュリティ、通信スタイル
│   ├── dev/                   # Git、Python、Node.js 等
│   └── integrations/          # Microsoft Docs MCP 等
├── prompts/                   # ワークスペース用プロンプト
│   ├── create-workflow.prompt.md
│   └── sample.prompt.md
├── prompts_sync/              # グローバル用プロンプト
│   ├── git-commit.prompt.md
│   ├── git-commit-push.prompt.md
│   ├── git-pull.prompt.md
│   ├── debug-error.prompt.md
│   ├── write-tests.prompt.md
│   ├── review-agents-and-instructions.prompt.md
│   ├── review-retrospective-learnings.prompt.md
│   ├── export-session-log.prompt.md
│   ├── export-copilot-session-dialogue.prompt.md
│   ├── export-knowledge.prompt.md
│   ├── export-sync-to-public-skills.prompt.md
│   ├── wrap-up-work.prompt.md
│   ├── convert-to-tweet.prompt.md
│   └── refactor-context.prompt.md
└── skills/                    # Copilot Skills
    └── agentic-workflow-guide/

instructions/ の推奨構成

このテンプレートでは instructions_sync/ にグローバル用インストラクションを配置していますが、プロジェクト固有のルールを追加する場合は instructions/ サブフォルダを作成してください:

instructions/
├── core/           # 共通ルール(セキュリティ、通信スタイル)
├── dev/            # 開発ルール(Git、Python、Node.js 等)
├── agents/         # エージェント設計ルール
└── integrations/   # 外部連携(Microsoft Docs MCP 等)

グローバル設定との使い分け

VS Code では、ワークスペース用(.github/)とグローバル用(ユーザープロファイル)の 2 箇所にインストラクション/プロンプト/エージェントを配置できます。

配置場所 パス 用途
ワークスペース .github/instructions/, .github/prompts/, .github/agents/ プロジェクト固有のルール
グローバル (Windows) %APPDATA%/Code/User/instructions/, prompts/, agents/ 全プロジェクト共通のルール
グローバル (macOS/Linux) ~/.config/Code/User/instructions/, prompts/, agents/ 全プロジェクト共通のルール

複数プロジェクトで共通して使いたいルール(Git コミット規約、コーディングスタイル等)は、グローバル設定に配置することを推奨します。

Note: このテンプレートリポジトリでは _sync サフィックスのフォルダ(agents_sync/, instructions_sync/, prompts_sync/)を使用していますが、これは作者の環境でグローバル設定と同期するためのものです。
テンプレートを使う際は:

  • プロジェクト固有のルール → instructions/, prompts/, agents/
  • 全プロジェクト共通のルール → グローバル設定にコピー(@sync-to-global エージェントを使用可能)

copilot-instructions.mdAGENTS.md の違い

観点 copilot-instructions.md AGENTS.md
対象 GitHub Copilot 全般 Coding Agent / Codex
用途 回答スタイル、ポリシー ビルド手順、タスク境界
「日本語で回答」 pnpm install で依存解決」

エージェント設計の原則

  1. 目的を最初に固定する — 何を作るか、品質基準、出力形式を明確に
  2. タスクを小さく分割する — 1 つの巨大エージェントに全部やらせない
  3. 単一責務(SRP) — 調査・実装・レビューなど役割ごとに分離
  4. 一方向の依存 — 循環構造(A → B → A)を作らない
  5. 構造化データで受け渡し — YAML / JSON / Markdown で情報を伝達
  6. プロンプトは短く — 作業指示のみ、出力形式を明確に
  7. レビュー専用エージェントを用意 — 最終チェックは分離する

オーケストレーター構成

複数エージェントを統括する場合の推奨構成:

.github/agents/
├── orchestrator.agent.md  # 司令塔(コード編集しない)
├── plan.agent.md          # 既存コード分析と実装方針
├── impl.agent.md          # TDD に沿った実装 & テスト
└── review.agent.md        # コードレビューと修正

ポイント:

  • 各エージェントに「やること」と「やらないこと」を明記
  • オーケストレーターは進行管理のみ、実作業はサブエージェントに委譲
  • エージェント間は構造化データ(YAML/JSON)で受け渡し

runSubagent 運用Tips

得意 苦手
長尺調査、ログ解析 結果の深掘り(追加質問不可)
ファイル単位の独立作業 軽量タスク(オーバーヘッドが大きい)
計画→実装→レビューの段階分離 前ステップの詳細を保持したいワークフロー

注意点:

  • サブエージェントはステートレス(追加質問できない)
  • 直列実行のみ(並列化は非対応)
  • リトライ上限を設定して暴走を防ぐ

ベストプラクティス

Do ✅

  • 1 エージェント = 1 つの役割(単一責務)
  • エージェント間は YAML/JSON で受け渡し
  • 同じ入力なら同じ結果(冪等性)
  • 最終チェックは専用エージェントで
  • リトライ上限とフォールバックを明記

Don't ❌

  • 1 つのエージェントに全部やらせる
  • 循環依存(A → B → A)を作る
  • 長文プロンプトを書く
  • /dev/null へのリダイレクト
  • git push を自動実行

参考資料

📚 公式ドキュメント

GitHub Copilot / VS Code

📖 プロンプトエンジニアリング

Anthropic

その他

🙏 Inspiration & Thanks

ライセンス

CC BY-NC-SA 4.0

このリポジトリは Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International ライセンスの下で公開されています。

  • ✅ 帰属表示を行えば自由に共有・改変可能
  • ❌ 商用利用は禁止(商用利用を希望する場合はお問い合わせください)
  • ❌ AI/ML トレーニングへの使用は禁止

コントリビュート

Issue や Pull Request は歓迎です。バグ報告、機能提案、ドキュメント改善など、お気軽にどうぞ。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors