@aramassa/ai-rules 0.6.0 → 0.8.0

package/artifact/prompts/development/plan-fix.prompt.md

@@ -0,0 +1,366 @@
+---
+type: prompt
+category: workflow
+focus: plan-to-implementation
+---
+
+## prompt plan-fix ワークフロー
+
+### 概要
+
+VS Code の Plan モードで作成した計画が完成したら、この prompt を使用して GitHub Issue、ブランチ、PR の作成を一括で実行します。手動での Git 操作や Issue 起票を省略し、効率的に Agent Coding へ移行できます。
+
+### 目的
+
+計画完成後の定型的な操作を自動化し、以下を実現します：
+
+- Git ブランチ操作の簡略化
+- GitHub Issue 起票の効率化
+- PR 作成とベースブランチ設定の自動化
+- Agent Coding へのスムーズな移行
+
+### 前提条件
+
+- VS Code の Plan モードで `todo_plans/` に計画ファイルが作成済み
+- 計画の内容が十分に詳細化されている
+- Git リポジトリが初期化されている
+
+### ワークフロー
+
+#### Step 1: main ブランチに切り替えて最新化
+
+```bash
+# main ブランチに切り替え
+git checkout main
+
+# 最新の変更を取得
+git pull origin main
+```
+
+**確認ポイント**:
+- [ ] main ブランチに切り替わっている
+- [ ] ローカルが最新の状態である
+- [ ] コンフリクトが発生していない
+
+#### Step 2: 計画の最終確認
+
+`todo_plans/` ディレクトリ内の計画ファイルを確認します。
+
+**チェック項目**:
+- [ ] ファイル名が `YYYYMMDD_[機能名].md` 形式である
+- [ ] 背景、やること、実装計画が明確に記載されている
+- [ ] Phase 分けがされている
+- [ ] 受け入れ基準が記載されている
+
+**計画の例**:
+```
+todo_plans/
+└── 20250115_cli_feature_implementation.md
+```
+
+#### Step 3: GitHub Issue を起票
+
+計画ファイルを元に GitHub Issue を作成します。
+
+**Issue 作成のポイント**:
+- タイトル: `[機能名]: [機能概要]` の形式に統一
+- 本文: 計画ファイルの内容を含める
+- ラベル: 機能種別（`enhancement`, `bug`, `documentation`）とカテゴリを設定
+
+**Issue タイトルの例**:
+```
+[mastra-tool-mcp-docs]: CLI機能の追加
+```
+
+**ラベルの例**:
+- `enhancement`: 新機能
+- `bug`: バグ修正
+- `documentation`: ドキュメント更新
+- カテゴリ固有のラベル（例: `mastra-tool`, `language-detection`）
+
+#### Issue 作成後の確認
+
+- [ ] Issue が正しく作成された
+- [ ] Issue 番号が取得できた
+- [ ] ラベルが適切に付与された
+- [ ] 計画ファイルの内容が Issue 本文に反映された
+
+#### Step 4: plan ブランチを作成
+
+Issue 番号を使って `plan/{issue_number}` ブランチを作成します。
+
+```bash
+# Issue 番号を変数に設定（例: #123）
+ISSUE_NUMBER=123
+
+# plan ブランチを作成して切り替え
+git checkout -b plan/${ISSUE_NUMBER}
+
+# 確認
+git branch --show-current
+# 出力例: plan/123
+```
+
+**ブランチ命名規則**:
+- `plan/{issue_number}`: 単独 Issue の場合
+- `plan/{parent_issue_number}.{sub_issue_number}`: サブ Issue の場合
+
+#### Step 5: 計画ファイルをコミット
+
+計画ファイルを `plan/{issue_number}` ブランチにコミットします。
+
+```bash
+# 計画ファイルをステージング
+git add todo_plans/YYYYMMDD_[機能名].md
+
+# コミット
+git commit -m "Add implementation plan for [機能名]
+
+- [変更内容1]
+- [変更内容2]
+- [変更内容3]
+- Related to Issue #${ISSUE_NUMBER}"
+
+# リモートにプッシュ
+git push -u origin plan/${ISSUE_NUMBER}
+```
+
+**コミットメッセージのポイント**:
+- 1行目: 簡潔な要約
+- 空行を挟む
+- 箇条書きで詳細を記載
+- Issue 番号を明記
+
+#### Step 6: Pull Request を作成
+
+`plan/{issue_number}` から `main` への PR を作成します。
+
+**PR 作成のポイント**:
+- Base ブランチ: `main`
+- Head ブランチ: `plan/{issue_number}`
+- Draft モード: 実装完了まで draft 状態を維持
+- Issue リンク: `Closes #XXX` で自動クローズを設定
+
+**PR タイトルの例**:
+```
+[mastra-tool-mcp-docs]: CLI機能実装計画
+```
+
+**PR の確認**:
+- [ ] PR が draft モードで作成された
+- [ ] base ブランチが `main` である
+- [ ] head ブランチが `plan/{issue_number}` である
+- [ ] Issue とリンクされている
+
+#### Step 7: Agent Coding を開始
+
+`plan/{issue_number}` をベースブランチとして Agent Coding タスクを起動します。
+
+**VS Code での操作**:
+
+1. **GitHub Copilot Chat で Agent タスクを開始**
+   ```
+   @workspace /new task
+   ```
+
+2. **ベースブランチを指定**
+   - ベースブランチ: `plan/{issue_number}`
+   - タスク内容を入力
+
+3. **Agent が自動的に作業ブランチを作成**
+   - ブランチ名例: `agent/implement-cli-feature`
+
+**コマンドラインでの操作**:
+
+```bash
+# Agent 用のブランチを作成（手動の場合）
+git checkout -b agent/implement-cli-feature plan/${ISSUE_NUMBER}
+
+# Agent タスク起動（GitHub Copilot CLI など）
+# （環境に応じたコマンドを実行）
+```
+
+### コマンド一覧（まとめ）
+
+以下のコマンドを順に実行することで、plan-fix ワークフローを完了できます。
+
+```bash
+#!/bin/bash
+
+# Step 1: main ブランチに切り替えて最新化
+git checkout main
+git pull origin main
+
+# Step 2: 計画ファイルを確認（手動）
+# todo_plans/YYYYMMDD_[機能名].md を確認
+
+# Step 3: GitHub Issue を作成（Web UIまたはCopilot Chat経由）
+
+# Issue 番号を設定（例: #123）
+ISSUE_NUMBER=123
+
+# Step 4: plan ブランチを作成
+git checkout -b plan/${ISSUE_NUMBER}
+
+# Step 5: 計画ファイルをコミット
+git add todo_plans/YYYYMMDD_[機能名].md
+git commit -m "Add implementation plan for [機能名]
+
+- [変更内容1]
+- [変更内容2]
+- Related to Issue #${ISSUE_NUMBER}"
+
+git push -u origin plan/${ISSUE_NUMBER}
+
+# Step 6: Pull Request を作成（Web UIまたはCopilot Chat経由）
+
+# Step 7: Agent Coding を開始（VS Code Copilot Chat経由）
+
+echo "✅ Workflow completed!"
+echo "Next: Start Agent Coding with base branch plan/${ISSUE_NUMBER}"
+```
+
+### ベストプラクティス
+
+#### 計画ファイルの準備
+
+- **詳細度**: Agent が迷わず実装できるレベルの詳細度を確保
+- **Phase 分け**: 1つの Phase が 2-3時間で完了する規模に分割
+- **受け入れ基準**: 検証可能な形で明記
+
+#### Issue 作成時
+
+- **タイトル**: `[パッケージ名]: [機能概要]` の形式に統一
+- **ラベル**: 機能種別とカテゴリを適切に設定
+- **親子関係**: 必要に応じて親 Issue との関連を明記
+
+#### ブランチ運用
+
+- **命名規則の徹底**: `plan/{issue_number}` の形式を厳守
+- **寿命の管理**: plan ブランチは 1-3日以内に main へマージ
+- **クリーンアップ**: マージ後は速やかにブランチを削除
+
+#### PR 作成時
+
+- **draft モード**: 実装完了まで draft 状態を維持
+- **詳細な説明**: 次のステップを明記
+- **Issue リンク**: `Closes #XXX` で自動クローズを設定
+
+### トラブルシューティング
+
+#### ブランチの作成に失敗する
+
+**原因**: すでに同名のブランチが存在する
+
+**解決策**:
+```bash
+# 既存ブランチを確認
+git branch -a | grep plan
+
+# 既存ブランチを削除（必要に応じて）
+git branch -D plan/${ISSUE_NUMBER}
+git push origin --delete plan/${ISSUE_NUMBER}
+```
+
+#### PR 作成がエラーになる
+
+**原因**: リモートブランチが存在しない、または認証エラー
+
+**解決策**:
+```bash
+# リモートブランチが push されているか確認
+git branch -r | grep plan/${ISSUE_NUMBER}
+
+# 再度 push
+git push -u origin plan/${ISSUE_NUMBER}
+
+# PR を再作成（Web UIまたはCopilot Chat経由）
+```
+
+### よくある質問
+
+#### Q1: VS Code の Plan モードと prompt plan-fix の違いは？
+
+**A**: 
+- **Plan モード**: 計画の作成に特化
+- **prompt plan-fix**: 計画完成後の Git/GitHub 操作を自動化
+
+両者は補完関係にあり、併用することで効率的なワークフローを実現できます。
+
+#### Q2: 計画が未完成の状態で plan-fix を実行してもよいか？
+
+**A**: 推奨しません。計画が未完成の場合、以下の問題が発生します：
+- Agent が実装方針を理解できない
+- レビューで大幅な修正が必要になる
+- 実装のやり直しが発生する
+
+計画を十分に詳細化してから plan-fix を実行してください。
+
+#### Q3: Issue 作成後に計画を修正したい場合は？
+
+**A**: 以下の手順で修正できます：
+
+1. 計画ファイルを修正
+2. `plan/{issue_number}` ブランチで再コミット
+3. PR を更新
+4. Issue にコメントで変更点を記載
+
+```bash
+git checkout plan/${ISSUE_NUMBER}
+# 計画ファイルを修正
+git add todo_plans/YYYYMMDD_[機能名].md
+git commit -m "Update implementation plan: [変更内容]"
+git push
+```
+
+#### Q4: 複数の Agent タスクを並行して実行したい場合は？
+
+**A**: `plan/{issue_number}` から複数の `agent/*` ブランチを作成します：
+
+```
+plan/123
+  ├── agent/implement-core-feature  → PR → plan/123
+  ├── agent/add-tests               → PR → plan/123
+  └── agent/update-docs             → PR → plan/123
+```
+
+各 Agent ブランチは独立して作業し、完了後に `plan/123` へマージします。
+
+#### Q5: Agent Coding を使わず手動で実装する場合は？
+
+**A**: plan-fix で作成したブランチ構造は手動実装でも利用できます：
+
+```bash
+# plan ブランチで直接実装
+git checkout plan/${ISSUE_NUMBER}
+
+# 実装
+# ...
+
+# コミット & プッシュ
+git add .
+git commit -m "Implement [機能名]"
+git push
+
+# PR を Ready for review に変更（Web UI経由）
+```
+
+### 関連ドキュメント
+
+- プランニングワークフロー マニュアル（planning-workflow.md）
+- Git ブランチ命名規則（git-rules.md）
+- todo_plans への記載項目（todo_planning.md）
+
+### まとめ
+
+prompt plan-fix ワークフローを使用することで：
+
+✅ **効率化**: Git/GitHub 操作を一括実行
+✅ **一貫性**: 標準的なブランチ・Issue 構造を維持
+✅ **追跡可能性**: Issue と PR で進捗を可視化
+✅ **スムーズな移行**: Agent Coding へ迅速に移行
+
+---
+
+**作成日**: 2025年1月15日
+**バージョン**: 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aramassa/ai-rules",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "This repository collects guidelines and instructions for developing AI agents. It contains documents covering communication rules, coding standards, testing strategies, and general operational practices.",
   "workspaces": [
     "packages/extract",

package/presets/agents.yaml

@@ -0,0 +1,26 @@
+config:
+  baseDir: .github/agents
+description: |
+  GitHub Copilot custom agent definitions for specialized development tasks.
+  These agents provide tailored expertise for agent creation, testing, planning, and documentation.
+
+recipe:
+  - title: Agent Creation Assistant
+    frontmatter:
+      "@description": true
+      "@tools": true
+      "@target": true
+    out: agent-creation.agent.md
+    filters:
+      name: agent-creation
+      target: github-copilot
+
+  - title: E2E Test Executor
+    frontmatter:
+      "@description": true
+      "@tools": true
+      "@target": true
+    out: e2e-test-executor.agent.md
+    filters:
+      name: e2e-test-executor
+      target: github-copilot

package/presets/github-actions/test.yaml

@@ -0,0 +1,18 @@
+description: GitHub Actionsのテストワークフローを実装するための設定です。
+
+recipe:
+  - import: :basic
+  - title: GitHub Actions Test Workflow Rules
+    frontmatter:
+      "@type": true
+      "@category": true
+      "@focus": true
+      description: |
+        Implementation rules for test workflows with GitHub Actions.
+        Covers workflow triggers, Node.js version matrix, build and test execution order,
+        and comprehensive validation including build artifact verification.
+      applyTo: ".github/workflows/*.{yml,yaml}"
+    out: ./.github/instructions/github-actions-test.instructions.md
+    type: test
+    category: github-actions
+    focus: test-workflow

package/presets/prompts/plan-fix.yaml

@@ -0,0 +1,15 @@
+description: VS Code Plan モードから Agent Coding への移行を自動化するワークフロー。計画完成後の GitHub Issue、ブランチ、PR 操作を簡略化します。
+
+config:
+  baseDir: .github/prompts
+
+recipe:
+  - title: "prompt plan-fix ワークフロー"
+    out: "plan-fix.prompt.md"
+    type: "prompt"
+    filters:
+      category: "workflow"
+      focus: "plan-to-implementation"
+    frontmatter:
+      description: "VS Code Plan モードから Agent Coding への移行を自動化。計画完成後の Git/GitHub 操作を簡略化し、効率的な開発ワークフローを実現。"
+      applyTo: "**/*"