create-pr について
create-prは、小規模で独立した修正のプルリクエストを準備するjackin'の開発スキルです。リポジトリのルールとツールに沿って、ブランチ作成、コミット、PR本文の生成、表示確認を進めます。
主な機能
- 01main以外のブランチ選択
- 02Conventional CommitsとDCO署名付きコミット
- 03差分とテンプレートに基づくPR本文生成
- 04変更内容に応じた検証項目の選択
- 05PR本文の表示確認
活用シーン
- 01誤字やドキュメント修正のPR作成
- 02依存関係更新や一行修正の提出
- 03リポジトリの検証手順に沿ったPR準備
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jackin-project/ jackin-dev --skill create-prインストール後、Claude Code で/create-prを入力して読み込まれたか確認します。
詳細
create-pr
jackin' リポジトリの小さな修正(誤字、依存関係の更新、1 行のバグ修正、ドキュメントの調整など)について、ロードマップ項目を必要とせずに PR を作成します。また、ほかのスキルでも再利用される PR 作成手順を共有します。コミットはこのスキル内で行い、別途コミット用スキルは使用しません。
jackin' のルールファイルは自動的に読み込まれます — PULL_REQUESTS.md、.github/ のエージェントルール、BRANCHING.md、COMMITS.md。このスキルはそれらの手順を組み立てるだけで、内容を繰り返し説明することはありません。ルールの全容は各ファイルを読んでください。
使用する場合
- オペレーターが
/jackin-dev:create-prを実行した場合。 - 小規模で自己完結した変更(設計不要、ロードマップ項目なし)。
使用しない場合
- ロードマップ項目にする価値のある機能やアイデア →
/jackin-dev:propose。 - 確定済みのロードマップ項目を実装する場合 →
/goal Implement <slug>.md。
引数
--branch <name>— ブランチ名を明示します。--auto-branch— 確認なしでブランチ名を選択します。--title <msg>— コミットと PR のタイトル(指定しない場合は差分から Conventional Commits に従って決定します)。
手順
- ブランチ。
mainには絶対にコミットしないでください。mainにいる場合は、変更内容に基づく名前で、fix/、chore/、docs/、refactor/のいずれかをプレフィックスにしたブランチを作成します。--auto-branchまたは--branchが指定されていない場合は、ブランチ名を提案して確認します。 - コミット。 未コミットの変更がある場合は、
COMMITS.mdに従い、このスキル内でコミットします。件名は Conventional Commits に従い、DCO の署名を付けます(git commit -s)。すでにコミット済みの場合はスキップします。その後、git pushを実行します。 - 本文を作成。
[bin]cargo xtask pr body --base origin/main > /tmp/pr-body.mdを実行します。分類された変更の概要(rust / docs / capsule / schema +ファイル一覧)は stderr に出力されるため、確認してください。本文のひな形はファイルに出力されます。実行時に.github/PULL_REQUEST_TEMPLATE.mdから読み込んだ PR テンプレートに、ローカル検証ブロックが選択済みの状態で、バイト単位で正確に挿入されています。本文はプレースホルダーのままです。ブロックの選択条件:Checkout + isolation env は常に含めます。Rust の変更では Rust テストを含めます。docs/**の変更では Docs checks + walk を含めます。crates/jackin-capsule/の変更では jackin-capsule のスモークテストを含めます(console/loadより前に--capsuleを指定)。バージョン付きスキーマに変更がある場合は、スキーマ移行のスモークテストを含めます。 - 記入して作成。
[agent]/tmp/pr-body.mdを編集し、概要と差分から本文の各セクション(Summary、What ships、Behavior changes)を記入します。不要な任意セクションは削除します。その後、gh pr create --body-file /tmp/pr-body.mdを実行します。本文はバイナリがすでに書き込んでいるため、引用符で囲む heredoc は不要です。 - レンダリングを確認。
gh pr view <PR> --json body -q .bodyを実行し、追加した本文が正しく表示されることを確認します(手編集による余計な\`` や$がないこと)。必要に応じてgh pr edit --body-file` で修正します。 - 返信。 PR の URL を共有し、最終メッセージでローカル検証用のコマンドを繰り返します。
よくある間違い
- ブランチではなく
mainにコミットする。 cargo xtask pr bodyを使わず、本文やテンプレートを手作業で作成する — このコマンドはテンプレートを読み込み、検証ブロックを自動で選択します。- 本文のプレースホルダーを埋めずに、ひな形のまま投稿する。
- 本文にデプロイ済みドキュメントの URL を記載する(マージ後にリンク切れになります)— ドキュメント名で参照してください。
ツール
cargo xtask pr body(jackin' リポジトリ)は、変更の概要と、差分に基づいてローカル検証ブロックを自動選択したテンプレートのひな形を出力します。propose と共有されています。バイナリが機械的な部分(ブロックの選択、カプセルの順序、コマンド文の正確さ、heredoc の引用符処理)を保証し、本文はエージェントが記入します。
コメント
Markdown 対応