visual-pr

プルリクエストを説明する

現在のタスクのプルリクエストを作成または更新し、変更の理由と実装の概要をレビュアーが理解できるよう、簡潔に説明します。

ワークフロー

1. 説明テンプレートを読みます。

   Read({SKILLBASE}/references/pr_description_template.md)

2. プルリクエストを特定または作成します。

   • 現在のブランチにプルリクエストがあるか、gh pr view --json url,number,title,state,baseRefName,headRefName 2>/dev/null で確認します。
   • プルリクエストがない場合は、git status --short --branch と現在のブランチのコミットを確認します。
   • 必要に応じてタスクに関連する変更をコミットし、ブランチをアップストリーム付きでプッシュして、プルリクエストを作成します。リポジトリの Git 安全性プロトコルに従ってください。
   • 現在のブランチに関連する作業がなく、安全に作成できる現在のブランチのプルリクエストもない場合に限り、ユーザーにプルリクエストの選択を依頼します。

3. 変更の説明に必要なコンテキストだけを集めます。

   • チケットと関連するタスク資料を読みます。
   • プルリクエストの差分全体と、動作や担当範囲を理解するために必要な周辺コードを読みます。
   • gh pr view を使用して、プルリクエストのメタデータと変更ファイルを確認します。
   • プルリクエスト本文に使うビジュアルな概要の規約について、{SKILLBASE}/references/show-me.md を読みます。

4. テンプレートを使ってプルリクエストの説明を書きます。

   • Why the change は、必ず1文にします。
   • Special things to note は1～3個の箇条書きにします。レビュアーへの注意、移行、互換性の制約、意図的に含めなかったもの、意外な判断を優先します。特記事項がなければ - None. と記載します。
   • Change outline は、文章やファイルごとの変更一覧ではなく、/show-me を参考にした簡潔な構造的ビューにします。
   • このプルリクエストの説明に役立つビューのみを含めます。
     • SQL テーブルやエンドポイントの契約の変更、およびビジネスロジックの疑似コード。
     • 主要なデータ構造や型の変更。
     • 変更箇所の役割が分かる、階層の浅いファイルツリー。
     • 重要なフック、状態、パッケージ境界を含む React コンポーネントツリーの変更。
     • 呼び出しツリー、コールスタック、制御フロー、データフローの変更。
   • 既存の構造の変更を示す場合は、diff ブロックを優先します。大部分が新規の構造である場合や、差分表記では担当範囲や順序が分かりにくくなる場合は、完成形全体を示します。
   • 各ビューは、レビュアーが必要とする内容に絞ります。変更がないカテゴリは省略します。
   • 任意：チケット ID／URL、Humanlayer タスクの URL、関連する計画書やドキュメントの URL、その他関連リンクが分かっている場合は、ヘッダーに含めます。分からない場合はヘッダーを省略します。

5. 説明を保存して公開します。

   • タスクディレクトリがある場合は .humanlayer/tasks/{task-slug}/pr-description.md に保存します。ない場合は .humanlayer/tasks/pr-{number}/description.md に保存します。
   • gh pr edit {number} --body-file {output-path} でプルリクエストを更新します。
   • 更新が成功したことを確認します。

6. 完了を報告します。

   • {SKILLBASE}/references/describe_pr_final_answer.md を読みます。
   • プルリクエストの URL、保存した説明の URL、変更ファイルの簡潔な一覧を含め、指定された最終回答テンプレートに従って回答します。

必ず {SKILLBASE}/references/pr_description_template.md を読み、その内容に従ってください。プルリクエスト本文をテンプレートの範囲を超えて長くしないでください。

人から人に話すように書き、専門用語や俗語を避け、分かりやすく簡潔な文章にしてください。