@aramassa/ai-rules 0.9.5 → 0.9.7

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

@@ -0,0 +1,438 @@
+---
+type: prompt
+name: fix-implementation
+category: workflow
+focus: implementation-completion
+description: "実装完了後のワークフローを自動化。e2eテスト実行、PR本文更新、Checksへの登録を効率的に実施。"
+agent: agent
+---
+# prompt fix-implementation ワークフロー
+
+## 概要
+
+実装が完了したら、この prompt を使用して e2e テストの実行、PR 本文への情報追記、Checks の登録を一括で実施します。実装完了後の定型的な品質保証プロセスを効率化します。
+
+## 目的
+
+実装完了後の以下のタスクを自動化します：
+
+- e2e テストの実行と結果確認
+- PR 本文への実装情報の追記
+- e2e テスト実行 Checks の PR への登録
+- 品質保証プロセスの標準化
+
+## 前提条件
+
+- 実装が完了している（コードの変更が commit されている）
+- PR が作成されている
+- `docs-ai/e2e-test/` に該当機能の e2e テストドキュメントが存在する
+- gh CLI がインストール・認証されている
+
+## ワークフロー
+
+### Step 1: 現状確認
+
+```bash
+# PR番号を確認
+PR_NUMBER=$(gh pr view --json number -q '.number')
+echo "PR Number: $PR_NUMBER"
+
+# 現在のブランチを確認
+git branch --show-current
+
+# 実装の変更ファイルを確認
+git --no-pager diff --name-only origin/main...HEAD
+```
+
+**確認ポイント**:
+- [ ] PR が存在し、番号が取得できている
+- [ ] 実装ブランチにいる
+- [ ] 変更ファイル一覧が意図した内容と一致している
+
+### Step 2: 該当する e2e テストドキュメントの特定
+
+`docs-ai/e2e-test/` ディレクトリから、実装した機能に関連する e2e テストドキュメントを探します。
+
+```bash
+# e2e テストドキュメント一覧を表示
+ls -la docs-ai/e2e-test/
+
+# 関連するドキュメントを確認（例: presets関連の場合）
+cat docs-ai/e2e-test/presets-command-e2e.md
+```
+
+**e2e テストドキュメントの構造**:
+- 各ドキュメントは機能ごとに分かれている
+- `[機能名]-[スコープ]-e2e.md` の命名規則
+- コマンドはコピペでそのまま実行可能
+
+### Step 3: e2e テストの実行
+
+該当する e2e テストドキュメントに記載されたコマンドを順次実行します。
+
+```bash
+# プロジェクトルートに移動
+cd /path/to/project
+
+# 依存関係をインストール（必要に応じて）
+npm install
+
+# プロジェクトをビルド
+npm run build
+
+# e2e テストドキュメントに記載されたコマンドを実行
+# 例: CLIコマンドの動作確認
+./dist/cli.js [コマンド] [オプション]
+
+# 結果を確認（成功の場合 ✓ マーク、失敗の場合 ✗ マーク）
+```
+
+**確認ポイント**:
+- [ ] 全ての e2e テストコマンドが成功している
+- [ ] 期待される出力が得られている
+- [ ] エラーが発生していない
+
+### Step 4: PR 本文への情報追記
+
+実装完了後、PR の本文に以下の情報を **追記** します。
+
+**追記する内容**:
+1. **実装した内容の概要** - 何を実装したか
+2. **テストや注意事項** - テスト方法や注意すべき点
+3. **想定される本番影響** - 本番環境への影響評価
+
+```bash
+# 現在のPR本文を取得
+CURRENT_BODY=$(gh pr view --json body -q '.body')
+
+# 追記する内容を作成
+APPEND_CONTENT="
+
+---
+
+## 実装完了レポート
+
+### 実装した内容の概要
+
+- [実装内容1]
+- [実装内容2]
+- [実装内容3]
+
+### テストや注意事項
+
+#### 実行したテスト
+- [ ] ユニットテスト: \`npm test\`
+- [ ] e2e テスト: \`docs-ai/e2e-test/[該当ファイル].md\` の手順を実行
+- [ ] 手動動作確認
+
+#### 注意事項
+- [注意事項1]
+- [注意事項2]
+
+### 想定される本番影響
+
+#### 影響範囲
+- [影響を受けるモジュール/機能]
+
+#### リスク評価
+- **高リスク**: なし
+- **中リスク**: [該当あれば記載]
+- **低リスク**: [該当あれば記載]
+
+#### 切り戻し方法
+- [問題発生時の切り戻し手順]
+"
+
+# PR本文を更新（既存内容 + 追記内容）
+echo "${CURRENT_BODY}${APPEND_CONTENT}" | gh pr edit --body-file -
+```
+
+**PR本文追記テンプレート（コピペ用）**:
+
+```markdown
+---
+
+## 実装完了レポート
+
+### 実装した内容の概要
+
+- [機能Aの実装]
+- [機能Bの改善]
+- [バグXの修正]
+
+### テストや注意事項
+
+#### 実行したテスト
+- [x] ユニットテスト: `npm test` - 全テスト通過
+- [x] e2e テスト: `docs-ai/e2e-test/presets-command-e2e.md` の手順を実行
+- [x] 手動動作確認
+
+#### 注意事項
+- 既存の設定ファイルとの互換性を確認してください
+- 環境変数 `XXX` の設定が必要です
+
+### 想定される本番影響
+
+#### 影響範囲
+- `packages/core/` - 新機能追加
+- `packages/cli/` - コマンドオプション追加
+
+#### リスク評価
+- **高リスク**: なし
+- **中リスク**: なし
+- **低リスク**: CLI出力フォーマットの軽微な変更
+
+#### 切り戻し方法
+- このPRをリバートすることで元の状態に戻せます
+```
+
+### Step 5: e2e テスト実行 Checks の PR 登録
+
+e2e テストを実行したことを PR の Checks として登録します。
+
+**方法1: GitHub API を使用してチェック実行を作成**
+
+```bash
+# リポジトリ情報を取得
+REPO=$(gh repo view --json nameWithOwner -q '.nameWithOwner')
+COMMIT_SHA=$(git rev-parse HEAD)
+
+# Check Run を作成
+gh api \
+  --method POST \
+  -H "Accept: application/vnd.github+json" \
+  -H "X-GitHub-Api-Version: 2022-11-28" \
+  /repos/${REPO}/check-runs \
+  -f name='E2E Tests' \
+  -f head_sha="${COMMIT_SHA}" \
+  -f status='completed' \
+  -f conclusion='success' \
+  -f output='{"title":"E2E Tests Passed","summary":"All e2e tests from docs-ai/e2e-test/ passed successfully."}' \
+  -f started_at="$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
+  -f completed_at="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
+```
+
+**方法2: PRにコメントとして e2e テスト結果を記録**
+
+```bash
+# e2e テスト結果をコメントとして追加
+gh pr comment $PR_NUMBER --body "## E2E テスト実行結果
+
+**実行日時**: $(date '+%Y-%m-%d %H:%M:%S')
+
+### 実行したテスト
+- ✅ \`docs-ai/e2e-test/[該当ファイル].md\` のコマンドを実行
+
+### 結果サマリ
+- ✅ 全テスト通過
+- 実行環境: [環境情報]
+
+### 実行ログ（抜粋）
+\`\`\`
+[テスト実行ログの抜粋]
+\`\`\`
+"
+```
+
+**確認ポイント**:
+- [ ] Check Run が正常に作成された、またはコメントが追加された
+- [ ] PR の Checks タブに e2e テスト結果が表示されている
+
+### Step 6: 最終確認
+
+```bash
+# PR の状態を確認
+gh pr view --json title,state,body,labels,checks
+
+# Checks の状態を確認
+gh pr checks
+
+# 変更内容の最終確認
+gh pr diff
+```
+
+**最終確認チェックリスト**:
+- [ ] 全ての e2e テストが成功している
+- [ ] PR 本文に実装情報が追記されている
+- [ ] Checks に e2e テスト結果が登録されている
+- [ ] レビュー依頼の準備が整っている
+
+## コマンド一覧（まとめ）
+
+以下のコマンドを順に実行することで、fix-implementation ワークフローを完了できます。
+
+```bash
+#!/bin/bash
+
+# Step 1: 現状確認
+PR_NUMBER=$(gh pr view --json number -q '.number')
+echo "PR Number: $PR_NUMBER"
+
+# Step 2: e2e テストドキュメントの確認
+ls docs-ai/e2e-test/
+
+# Step 3: e2e テストの実行（該当するドキュメントに従う）
+npm run build
+# [e2e テストコマンドを実行]
+
+# Step 4: PR本文への追記
+# （上記のテンプレートを使用してPR本文を更新）
+
+# Step 5: Checks の登録
+REPO=$(gh repo view --json nameWithOwner -q '.nameWithOwner')
+COMMIT_SHA=$(git rev-parse HEAD)
+
+gh api \
+  --method POST \
+  -H "Accept: application/vnd.github+json" \
+  -H "X-GitHub-Api-Version: 2022-11-28" \
+  /repos/${REPO}/check-runs \
+  -f name='E2E Tests' \
+  -f head_sha="${COMMIT_SHA}" \
+  -f status='completed' \
+  -f conclusion='success' \
+  -f output='{"title":"E2E Tests Passed","summary":"E2E tests completed successfully."}' \
+  -f started_at="$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
+  -f completed_at="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
+
+# Step 6: 最終確認
+gh pr view
+gh pr checks
+
+echo "✅ fix-implementation workflow completed!"
+```
+
+## e2e テストドキュメントの書き方
+
+実装する機能に対応する e2e テストドキュメントが存在しない場合は、新規作成してください。
+
+**ファイル命名規則**: `[機能名]-[スコープ]-e2e.md`
+
+**必須セクション**:
+1. **前提条件** - 実行環境、必要なツール
+2. **全体ビルド・テスト** - プロジェクト全体のビルド・テスト
+3. **機能固有のテスト** - 対象機能の動作確認
+4. **エラーケース** - 異常系の確認
+5. **クリーンアップ** - 一時ファイルの削除等
+
+**テンプレート例**:
+
+```markdown
+---
+feature: [機能名]
+purpose: E2E テストコマンド集
+---
+
+# [機能名] E2E Tests
+
+## 前提条件
+
+\`\`\`bash
+cd /path/to/project
+npm install
+npm run build
+\`\`\`
+
+## 基本動作確認
+
+### 正常系
+
+\`\`\`bash
+# コマンド実行
+./dist/cli.js [command] [options]
+
+# 期待される出力を確認
+\`\`\`
+
+### エラーケース
+
+\`\`\`bash
+# エラーケースの確認
+./dist/cli.js [invalid-command] 2>&1 || echo "Expected error occurred"
+\`\`\`
+
+## クリーンアップ
+
+\`\`\`bash
+# 一時ファイルの削除
+rm -rf /tmp/test-output
+\`\`\`
+```
+
+## ベストプラクティス
+
+### e2e テスト実行時
+
+- **環境の一致**: ローカル環境と CI 環境の差異を考慮
+- **再現性**: 同じコマンドで同じ結果が得られることを確認
+- **ドキュメント更新**: テスト内容が変わったらドキュメントも更新
+
+### PR 本文更新時
+
+- **簡潔に**: 重要な情報を簡潔にまとめる
+- **具体的に**: 抽象的な表現を避け、具体的な変更点を記載
+- **リスク明示**: 本番影響を正直に評価
+
+### Checks 登録時
+
+- **正確な結果**: テスト結果を正確に報告
+- **失敗時の対応**: テスト失敗時は conclusion を 'failure' に設定
+- **詳細情報**: 必要に応じてログの抜粋を含める
+
+## トラブルシューティング
+
+### e2e テストが失敗する場合
+
+**原因**: 環境の違い、依存関係の不整合
+
+**解決策**:
+```bash
+# クリーンビルド
+rm -rf node_modules dist
+npm install
+npm run build
+
+# 再度テスト実行
+```
+
+### Check Run の作成に失敗する場合
+
+**原因**: GitHub API の権限不足
+
+**解決策**:
+- リポジトリの Settings → Actions → General で権限を確認
+- GitHub App を使用している場合は `checks:write` 権限を付与
+- 代替手段として PR コメントを使用
+
+### PR 本文の更新に失敗する場合
+
+**原因**: gh CLI の認証エラー
+
+**解決策**:
+```bash
+# 認証状態を確認
+gh auth status
+
+# 再認証
+gh auth login
+```
+
+## 関連ドキュメント
+
+- [plan-fix プロンプト](./plan-fix.prompt.md) - 計画完成後のワークフロー
+- [TODO Plans 作成ルール](./todo_plans.prompt.md) - 計画管理
+- [e2e テストガイドライン](../../../docs-ai/e2e-test/README.md) - e2e テストの書き方
+
+## まとめ
+
+prompt fix-implementation ワークフローを使用することで：
+
+✅ **品質保証**: e2e テストによる品質確認
+✅ **透明性**: PR 本文への詳細な実装情報追記
+✅ **追跡可能性**: Checks への e2e テスト結果登録
+✅ **標準化**: 実装完了プロセスの統一
+
+---
+
+**作成日**: 2025年1月
+**バージョン**: 1.0.0

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

@@ -105,13 +105,30 @@ cat > "todo_plans/${ISSUE_NUMBER}/index.md" <<'EOF'
   - `testing.md`: テスト戦略・テストケース
   - `risks.md`: リスク評価と対策
   - `notes.md`: 設計メモ・その他補足
+  - `e2e-cmd.md`: E2E テスト（追加/更新/削除すべきコマンドラインテスト。詳細は artifact/instructions/rules/test/e2e-cmd.md を参照）
+
+## 関連ファイルの記載ルール
+
+計画ファイル内で関連ファイルやディレクトリを参照する場合は、**必ずプロジェクトルートからのフルパス**で記載してください。
+
+**良い例**:
+- `artifact/instructions/rules/test/e2e-cmd.md`
+- `todo_plans/123/index.md`
+- `packages/core/src/index.ts`
+
+**悪い例**:
+- `e2e-cmd.md`（相対パスが不明確）
+- `./index.md`（現在のディレクトリが不明確）
+- `src/index.ts`（どのパッケージか不明）
 EOF
 
 cat > "todo_plans/${ISSUE_NUMBER}/details.md" <<'EOF'
 # 補足（自由記述）
 
 ※補足はこのファイルに「全部」書く必要はありません。
-`todo_plans/${ISSUE_NUMBER}/` 配下に、用途別にファイルを増やしてOKです（例: `testing.md`, `risks.md`, `notes.md`）。
+`todo_plans/${ISSUE_NUMBER}/` 配下に、用途別にファイルを増やしてOKです（例: `testing.md`, `risks.md`, `notes.md`, `e2e-cmd.md`）。
+
+**重要**: ファイル内で関連ファイルを参照する際は、プロジェクトルートからのフルパスで記載してください。
 
 ## 背景
 
@@ -308,8 +325,11 @@ echo "Next: Start Agent Coding with base branch plan/${ISSUE_NUMBER}"
 
 - **index.md**: 人間が読む前提で、要点だけに絞る（Issue 本文と一致させる正本）
 - **補足ファイル**: 長い背景/Phase/受け入れ基準などは `todo_plans/${ISSUE_NUMBER}/` 配下に分割して置く（`details.md` はその一例）
+- **e2e-cmd.md**: E2E テストの追加/更新/削除内容を記載（原則としてコマンドライン上で完結するテストのみ対象）
+  - 詳細は `artifact/instructions/rules/test/e2e-cmd.md` を参照
 - **Phase 分け**: 1つの Phase が 2-3時間で完了する規模に分割
 - **受け入れ基準**: 検証可能な形で明記
+- **ファイルパスの記載**: 関連ファイルは必ずプロジェクトルートからのフルパスで記載
 
 #### Issue 作成時
 
@@ -433,9 +453,10 @@ git push
 
 ### 関連ドキュメント
 
-- プランニングワークフロー マニュアル（planning-workflow.md）
-- Git ブランチ命名規則（git-rules.md）
-- todo_plans への記載項目（todo_planning.md）
+- プランニングワークフロー マニュアル（artifact/instructions/planning-workflow.md）
+- Git ブランチ命名規則（artifact/instructions/git-rules.md）
+- todo_plans への記載項目（artifact/instructions/todo_planning.md）
+- E2E コマンドラインテスト計画（artifact/instructions/rules/test/e2e-cmd.md）
 
 ### まとめ