pr-writing について
pr-writingは、リポジトリ内の情報をもとにPull Requestのタイトルと本文を作成するスキルです。プロジェクトに合う形式を選び、根拠のある記述と不明点の明示を促します。
主な機能
- 01リポジトリ用ヘルパースクリプト
- 02プロファイル別のPR作成
- 03チケットに応じたタイトル規則
- 04説明・テスト欄の作成
- 05不明点の明示
活用シーン
- 01ブランチの変更内容からPRを作成
- 02フロントエンドPRにスクリーンショット欄を追加
- 03チケットに紐づくPRタイトルを作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/pr-writingを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlscripts/pr_writer.pytest_cli.py詳細
PR の作成
ヘルパースクリプトは、このスキルのディレクトリを基準とした scripts/pr_writer.py にあります（ハーネスが解決します）。ユーザーのリポジトリから、スクリプトの絶対パスまたはスキルからの相対パスを指定して実行します。
python3 <skill-dir>/scripts/pr_writer.py
手順
- ヘルパーを実行するか、ブランチを調べます。ソース、ターゲット、コミット、変更ファイルが分かれば完了です。
- プロファイルを検出するか、
--profileを指定します。Description、Test Plan、Test Result、Links を含む下書きを作成します。frontendの場合のみ Screenshot を追加します。 - タイトルを作成します。
featは動作の追加、fixは修正、refactorは構造の再編を表します。ブランチまたはコミットにチケットがある場合：<feat|fix|refactor> [TICKET-123]: 簡潔な説明。チケットがない場合：<feat|fix|refactor> (feature-name): 簡潔な説明。 - すべての主張は、ローカルのコンテキストで裏付ける必要があります。不明な点は創作せず、不明であることを明記します。
完了条件：タイトルがチケットのルールに従い、本文に該当する見出しがあり、プロファイルがリポジトリに合っていて、不明な点が明記されていること。
コマンド
draft --repo-dir . [--target main] [--format toon] [--profile frontend]
プロファイル
| シグナル | プロファイル |
|---|---|
| React、Next、Vue、Nuxt、Svelte、Angular、Astro、Preact、React Native | frontend |
Flutter の pubspec.yaml | frontend |
Dart の pubspec.yaml | dart |
go.mod | go |
| なし | generic |
コメント
Markdown 対応