pre-pr について
pre-pr は、変更が動作した後、GitHub PR の作成前に使うメンテナー向けチェックリストです。差分に応じたテストやドキュメントを確認し、証拠を添えてリポジトリのテンプレートを埋めます。
主な機能
- 01差分に基づく変更分類
- 02必要なテストと文書の判定
- 03Lint・型検査・テストの実行
- 04PR 用の証拠収集
- 05PR 説明テンプレートの記入
活用シーン
- 01GitHub PR の作成準備
- 02変更に必要なテスト範囲の確認
- 03コマンド結果と動作証拠の整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ plastic-labs/ honcho --skill pre-prインストール後、Claude Code で/pre-prを入力して読み込まれたか確認します。
詳細
PR 前チェックリスト
変更が動作するようになった後、誰かが GitHub の PR を作成する前に実施してください。テンプレートに記入した本文を出力します。PR は作成しないでください。
テンプレートの場所は .github/pull_request_template.md です。セクションを追加しないでください。
1. 差分を分類する
git diff main...HEAD --stat
主な種類を 1 つ選びます:バグ、機能、ドキュメント。次に、対象レイヤーを判断します。
| 変更対象 | 必須項目 |
|---|---|
src/(プロンプト以外) | 対応する tests/ ツリー配下のユニットテスト |
| deriver / dialectic / dreamer / LLM パス | ユニットテスト+live-llm を検討(tests/live_llm) |
| キュー、設定階層、マルチターン、SDK 契約 | unified(uv run python -m tests.unified.run) |
/v3 HTTP または deriver のキュー動作 | /verify スキル(pytest だけでなく、実行時の動作も確認) |
パブリック API、SDK のエクスポート、config.toml /設定、mintlify docs/ | 対応するファイルのドキュメント |
1 行で理由を示す場合に限り、レイヤーを省略できます(例:「ドキュメントのみ」「コメントのみ」)。「適切な場合」は省略理由になりません。
実行時の対象範囲に変更があった場合は /verify を実行してください。このスキルの内容をここで繰り返さないでください。
テストが成功したと報告する前に、Lint と型チェックを実施します:uv run ruff check src/ → uv run basedpyright → 対象レイヤーの pytest コマンド。
2. 証拠
コミットではなく、PR に記載する証拠を集めます。
- 実行したコマンドと、その成功または失敗
- 新しい動作を示すログの抜粋、スクリーンショット、またはファイルパス
- バグの場合:可能であれば、修正前と修正後の失敗ケース
/verify を実行した場合は、そのセッションの出力が証拠になります。実行していないのに成功したと記載しないでください。
3. 本文を書く
プルリクエストの説明テンプレートの説明と証拠の部分に記入します。
関連する GitHub issue がある場合は、Fixes #<N> でリンクします。
コメント
Markdown 対応