AgentSkillsCN

pr-top-comment

命令说明

SKILL.md
--- frontmatter
name: pr-top-comment
description: コマンドの説明

GitHub PRのトップコメントを以下のルールに従って生成してください:

フォーマット

必ず以下の3セクション構成にする:

  1. Issue

  2. Description

  3. Self-check

記載ルール

Issueセクション

  • 関連するGitHub Issue番号、PR番号、エラーURL等を記載
  • Notion/Sentry/SlackのURLがあれば追加
  • コメント「<!-- 後の履歴を管理しやすくするために、Notion/Sentry/SlackのURLを記載する -->」を含める

Descriptionセクション

  • 「なぜ」この変更が必要かを簡潔に説明(1-3文)
  • 問題の背景と、この変更で何が解決されるかを記載
  • コメント「<!-- 画面の変更がある場合はスクショを添付 -->」を含める
  • 以下は書かない:
    • コード差分を見ればわかる内容(何を変更したか)
    • ファイル名や行数
    • 追加・削除したコードの詳細
    • 自明な実装内容

Self-checkセクション

  • チェックリスト形式「- [ ]」で記載
  • 実質的な確認項目のみ(3-5項目程度)
  • コメント「<!-- 実装者としてセルフチェックした項目を記入。必要に応じて追記・改変してください。 -->」を含める
  • 含めるべき項目例:
    • 動作確認の予定
    • 影響範囲の検討
    • 今後の課題や検討事項
    • テストの実行状況

出力言語

  • 日本語で記載
  • 技術用語は適切に英語のまま使用

重要な原則

  1. 簡潔性:レビュアーの時間を尊重
  2. 本質性:「なぜ」に焦点を当てる
  3. 非冗長性:コード差分でわかることは書かない
  4. 実用性:形式的なチェック項目は避ける