Prompt file imported from USEN-PAY-Products/connect-wholesale-gas-poc (.github/prompts/pr-work-summary.prompt.md). Copyright stays with the author.

PR 作業まとめドキュメント生成

Name: pr-work-summary
Author: USEN-PAY-Products

現在の作業ブランチで行った変更内容を、PRレビュー用のドキュメントとしてまとめてください。

手順

ブランチ情報の取得
- git rev-parse --abbrev-ref HEAD で現在のブランチ名を取得する
- ブランチ名から MYP チケット番号を抽出する（例: feature/MYP-3709-implement-logout → MYP-3709）
差分の取得
- git diff develop...HEAD --stat で変更ファイル一覧を取得する
- git diff develop...HEAD で全差分を取得する
- git log develop..HEAD --oneline でコミット一覧を取得する
PR 情報の取得（利用可能な場合）
- GitHub PR のタイトル・説明を確認する
変更内容の分析
- 差分を読み解き、各ファイルの変更意図・変更種別（追加/変更/削除）を把握する
- 設計方針や重要な判断事項を抽出する
ドキュメントの生成
- 以下のフォーマットに従って docs/pr_work_logs/PR_作業まとめ_{チケット番号}.md に出力する

出力フォーマット

# PR 作業まとめ: {チケット番号} {PRタイトル or 作業内容の要約}

## 概要

{この PR で何を実装・修正したかを 2〜4 行で簡潔に記述}

## 対象ブランチ

`{ブランチ名}` → `develop`

---

## 変更ファイル一覧

| ファイル | 変更種別 | 変更内容 |
|----------|---------|---------|
| `src/xxx.js` | 追加/変更/削除 | {そのファイルで何を変えたかを 1 行で} |

---

## 設計方針

{重要な設計判断や方針があれば記述。Before/After 比較表や図を使って分かりやすく}

---

## 全体フロー図

{変更内容に応じて、以下のような Mermaid 図を作成する}

### 処理フロー（flowchart）

- 新しい処理フローがある場合、ユーザー操作→FE→BE→BQ の流れを flowchart TD で図示
- 条件分岐や並列処理がある場合は分岐ノードを使って表現する

### シーケンス図（sequenceDiagram）

- FE/BE/BQ/外部サービス間のやり取りがある場合、sequenceDiagram で時系列の処理フローを図示
- 正常系と異常系（alt/else）を明示する
- Note を使って重要な処理ポイントを補足する

{例:}
```mermaid
sequenceDiagram
    actor User as ユーザー
    participant FE as FE (fe_js.html)
    participant BE as BE (be_xxx.js)
    participant BQ as BigQuery

    User->>FE: 操作
    FE->>BE: google.script.run.xxx()
    BE->>BQ: クエリ実行
    BQ-->>BE: 結果
    BE-->>FE: レスポンス

{変更が単純な場合（CSS修正のみ、文言変更のみ等）はこのセクションを省略してよい}

変更詳細

{ファイルごとの変更詳細。関数の追加・修正内容、パラメータ、ロジックの変更点などを記述} {コードスニペットは最小限にし、変更の意図が伝わるレベルで}

コーディングルール準拠

ルール	対応
`var` 禁止 → `const` / `let` 使用	✅ or ❌
内部関数は末尾 `_`	✅ or ❌
`function` キーワードで定義	✅ or ❌

影響範囲

機能影響: {既存機能への影響の有無と内容}
パフォーマンス影響: {パフォーマンスへの影響があれば記述}


## 注意事項

- 日本語で記述すること
- コーディングルールは `docs/CODING_RULES.md` を参照して判定すること
- 変更詳細では、レビュアーが差分を理解しやすいように「なぜその変更をしたか」を意識して書くこと
- **Mermaid 図は積極的に使うこと**: 処理フローには `flowchart TD`、FE/BE/BQ間の通信には `sequenceDiagram` を使う。既存の PR 作業まとめドキュメント（`docs/pr_work_logs/` 配下）のスタイルを参考にする
- 状態遷移がある場合は ASCII アートやテーブルで Before/After を対比すること
- コードブロックを大量に貼り付けるのではなく、変更のポイントを要約すること

# PR 作業まとめドキュメント生成現在の作業ブランチで行った変更内容を、PRレビュー用のドキュメントとしてまとめてください。 ## 手順 1. **ブランチ情報の取得** - `git rev-parse --abbrev-ref HEAD` で現在のブランチ名を取得する - ブランチ名から MYP チケット番号を抽出する（例: `feature/MYP-3709-implement-logout` → `MYP-3709`） 2. **差分の取得** - `git diff develop...HEAD --stat` で変更ファイル一覧を取得する - `git diff develop...HEAD` で全差分を取得する - `git log develop..HEAD --oneline` でコミット一覧を取得する 3. **PR 情報の取得**（利用可能な場合） - GitHub PR のタイトル・説明を確認する 4. **変更内容の分析** - 差分を読み解き、各ファイルの変更意図・変更種別（追加/変更/削除）を把握する - 設計方針や重要な判断事項を抽出する 5. **ドキュメントの生成** - 以下のフォーマットに従って `docs/pr_work_logs/PR_作業まとめ_{チケット番号}.md` に出力する ## 出力フォーマット ```markdown # PR 作業まとめ: {チケット番号} {PRタイトル or 作業内容の要約} ## 概要 {この PR で何を実装・修正したかを 2〜4 行で簡潔に記述} ## 対象ブランチ `{ブランチ名}` → `develop` --- ## 変更ファイル一覧 | ファイル | 変更種別 | 変更内容 | |----------|---------|---------| | `src/xxx.js` | 追加/変更/削除 | {そのファイルで何を変えたかを 1 行で} | --- ## 設計方針 {重要な設計判断や方針があれば記述。Before/After 比較表や図を使って分かりやすく} --- ## 全体フロー図 {変更内容に応じて、以下のような Mermaid 図を作成する} ### 処理フロー（flowchart） - 新しい処理フローがある場合、ユーザー操作→FE→BE→BQ の流れを flowchart TD で図示 - 条件分岐や並列処理がある場合は分岐ノードを使って表現する ### シーケンス図（sequenceDiagram） - FE/BE/BQ/外部サービス間のやり取りがある場合、sequenceDiagram で時系列の処理フローを図示 - 正常系と異常系（alt/else）を明示する - Note を使って重要な処理ポイントを補足する {例:} ```mermaid sequenceDiagram actor User as ユーザー participant FE as FE (fe_js.html) participant BE as BE (be_xxx.js) participant BQ as BigQuery User->>FE: 操作 FE->>BE: google.script.run.xxx() BE->>BQ: クエリ実行 BQ-->>BE: 結果 BE-->>FE: レスポンス ``` {変更が単純な場合（CSS修正のみ、文言変更のみ等）はこのセクションを省略してよい} --- ## 変更詳細 {ファイルごとの変更詳細。関数の追加・修正内容、パラメータ、ロジックの変更点などを記述} {コードスニペットは最小限にし、変更の意図が伝わるレベルで} --- ## コーディングルール準拠 | ルール | 対応 | |--------|------| | `var` 禁止 → `const` / `let` 使用 | ✅ or ❌ | | 内部関数は末尾 `_` | ✅ or ❌ | | `function` キーワードで定義 | ✅ or ❌ | --- ## 影響範囲 - **機能影響**: {既存機能への影響の有無と内容} - **パフォーマンス影響**: {パフォーマンスへの影響があれば記述} ``` ## 注意事項 - 日本語で記述すること - コーディングルールは `docs/CODING_RULES.md` を参照して判定すること - 変更詳細では、レビュアーが差分を理解しやすいように「なぜその変更をしたか」を意識して書くこと - **Mermaid 図は積極的に使うこと**: 処理フローには `flowchart TD`、FE/BE/BQ間の通信には `sequenceDiagram` を使う。既存の PR 作業まとめドキュメント（`docs/pr_work_logs/` 配下）のスタイルを参考にする - 状態遷移がある場合は ASCII アートやテーブルで Before/After を対比すること - コードブロックを大量に貼り付けるのではなく、変更のポイントを要約すること

{ "prompt": "# PR 作業まとめドキュメント生成\n\n現在の作業ブランチで行った変更内容を、PRレビュー用のドキュメントとしてまとめてください。\n\n## 手順\n\n1. **ブランチ情報の取得**\n - `git rev-parse --abbrev-ref HEAD` で現在のブランチ名を取得する\n - ブランチ名から MYP チケット番号を抽出する（例: `feature/MYP-3709-implement-logout` → `MYP-3709`）\n\n2. **差分の取得**\n - `git diff develop...HEAD --stat` で変更ファイル一覧を取得する\n - `git diff develop...HEAD` で全差分を取得する\n - `git log develop..HEAD --oneline` でコミット一覧を取得する\n\n3. **PR 情報の取得**（利用可能な場合）\n - GitHub PR のタイトル・説明を確認する\n\n4. **変更内容の分析**\n - 差分を読み解き、各ファイルの変更意図・変更種別（追加/変更/削除）を把握する\n - 設計方針や重要な判断事項を抽出する\n\n5. **ドキュメントの生成**\n - 以下のフォーマットに従って `docs/pr_work_logs/PR_作業まとめ_{チケット番号}.md` に出力する\n\n## 出力フォーマット\n\n```markdown\n# PR 作業まとめ: {チケット番号} {PRタイトル or 作業内容の要約}\n\n## 概要\n\n{この PR で何を実装・修正したかを 2〜4 行で簡潔に記述}\n\n## 対象ブランチ\n\n`{ブランチ名}` → `develop`\n\n---\n\n## 変更ファイル一覧\n\n| ファイル | 変更種別 | 変更内容 |\n|----------|---------|---------|\n| `src/xxx.js` | 追加/変更/削除 | {そのファイルで何を変えたかを 1 行で} |\n\n---\n\n## 設計方針\n\n{重要な設計判断や方針があれば記述。Before/After 比較表や図を使って分かりやすく}\n\n---\n\n## 全体フロー図\n\n{変更内容に応じて、以下のような Mermaid 図を作成する}\n\n### 処理フロー（flowchart）\n\n- 新しい処理フローがある場合、ユーザー操作→FE→BE→BQ の流れを flowchart TD で図示\n- 条件分岐や並列処理がある場合は分岐ノードを使って表現する\n\n### シーケンス図（sequenceDiagram）\n\n- FE/BE/BQ/外部サービス間のやり取りがある場合、sequenceDiagram で時系列の処理フローを図示\n- 正常系と異常系（alt/else）を明示する\n- Note を使って重要な処理ポイントを補足する\n\n{例:}\n```mermaid\nsequenceDiagram\n actor User as ユーザー\n participant FE as FE (fe_js.html)\n participant BE as BE (be_xxx.js)\n participant BQ as BigQuery\n\n User->>FE: 操作\n FE->>BE: google.script.run.xxx()\n BE->>BQ: クエリ実行\n BQ-->>BE: 結果\n BE-->>FE: レスポンス\n```\n\n{変更が単純な場合（CSS修正のみ、文言変更のみ等）はこのセクションを省略してよい}\n\n---\n\n## 変更詳細\n\n{ファイルごとの変更詳細。関数の追加・修正内容、パラメータ、ロジックの変更点などを記述}\n{コードスニペットは最小限にし、変更の意図が伝わるレベルで}\n\n---\n\n## コーディングルール準拠\n\n| ルール | 対応 |\n|--------|------|\n| `var` 禁止 → `const` / `let` 使用 | ✅ or ❌ |\n| 内部関数は末尾 `_` | ✅ or ❌ |\n| `function` キーワードで定義 | ✅ or ❌ |\n\n---\n\n## 影響範囲\n\n- **機能影響**: {既存機能への影響の有無と内容}\n- **パフォーマンス影響**: {パフォーマンスへの影響があれば記述}\n```\n\n## 注意事項\n\n- 日本語で記述すること\n- コーディングルールは `docs/CODING_RULES.md` を参照して判定すること\n- 変更詳細では、レビュアーが差分を理解しやすいように「なぜその変更をしたか」を意識して書くこと\n- **Mermaid 図は積極的に使うこと**: 処理フローには `flowchart TD`、FE/BE/BQ間の通信には `sequenceDiagram` を使う。既存の PR 作業まとめドキュメント（`docs/pr_work_logs/` 配下）のスタイルを参考にする\n- 状態遷移がある場合は ASCII アートやテーブルで Before/After を対比すること\n- コードブロックを大量に貼り付けるのではなく、変更のポイントを要約すること", "variables": [], "notes": "現在のブランチの作業内容をPRレビュー用ドキュメントにまとめる", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/USEN-PAY-Products/connect-wholesale-gas-poc", "path": ".github/prompts/pr-work-summary.prompt.md", "ref": "0b9ff03e44d294e97998868044bcbdcaa1d9174a", "url": "https://github.com/USEN-PAY-Products/connect-wholesale-gas-poc/blob/0b9ff03e44d294e97998868044bcbdcaa1d9174a/.github/prompts/pr-work-summary.prompt.md", "key": "USEN-PAY-Products/connect-wholesale-gas-poc/.github/prompts/pr-work-summary.prompt.md" } } }

pr-work-summary

About

PR 作業まとめドキュメント生成

手順

出力フォーマット

変更詳細

コーディングルール準拠

影響範囲

Use it

Manifest

Reviews