create-pull-request
指定されたブランチからPull Requestを作成し、適切なタイトルと説明文を自動生成します。
When & Why to Use This Skill
This Claude skill automates the Pull Request (PR) creation process by generating professional titles and structured descriptions directly from specified branches. It streamlines the development lifecycle by ensuring every PR is documented with clear summaries, impact assessments, and reviewer checklists, significantly improving code review efficiency and maintaining high documentation standards within engineering teams.
Use Cases
- Automated PR Documentation: Quickly generate comprehensive Pull Request descriptions that include the purpose of changes, technical details, and issue tracking numbers to save developer time.
- Standardized Review Process: Ensure all team members follow a consistent PR template, making it easier for reviewers to identify impact areas and specific points requiring validation.
- Workflow Optimization: Seamlessly transition from coding to the review stage by automating the 'boring' parts of Git workflow, ensuring that 'why' and 'how' are always clearly communicated to the team.
| name | create-pull-request |
|---|---|
| description | 指定されたブランチからPull Requestを作成し、適切なタイトルと説明文を自動生成します。 |
Pull Requestのタイトルと説明文の自動生成
以下の内容を考慮してPull Requestの説明文を生成してください。
- 日本語で対応する: Pull Requestのタイトルと説明文は日本語で記述します。
- 変更内容を簡潔に説明する: 何を変更したのか、なぜその変更が必要だったのかを明確にします。
- 箇条書きでの記載を推奨: 変更点を箇条書きで整理することで、レビューアーが理解しやすくなります。
- 関連するIssue番号を含める: もし関連するIssueがあれば、その番号を記載します。
- 変更の影響範囲を明記する: どの部分に影響があるか、とくに注意が必要な点を記載します。
- 確認事項を記載する: レビューアーが確認すべきポイントや、とくに注意してほしい点を明記します。
- 文章のトーン: フォーマルでありながらも、親しみやすいトーンを心がけます。
- 「です・ます」調で記載する: タイトルおよび説明文は「です・ます」調で統一してください。
Pull Requestタイトル例
- 「ユーザープロファイル編集機能の実装」
- 「ログイン画面のレイアウト崩れを修正」
- 「データベースクエリの最適化」
Pull Requestテンプレート例
## 概要
この Pull Request では、以下の内容を変更しています。
- [何を変更したか]
- [なぜ変更が必要だったか]
- [解決する課題や改善点]
## 変更内容
本PRで実施した主な変更点は次のとおりです。
- [変更点1]
- [変更点2]
- [変更点3]
## 関連Issue
- #<Issue番号>(該当する場合のみ記載)
## 影響範囲
この変更によって影響を受ける可能性のある箇所は次のとおりです。
- [影響があるモジュールや機能]
- [副作用が考えられる箇所]
- [特に注意が必要なポイント]
## 確認事項
- [確認ポイント1]
- [確認ポイント2]
- [テスト結果や動作の確認ポイント]
## 補足
必要に応じて、補足情報やスクリーンショットを記載してください。
注意点
- Pull Requestの内容に応じて、上記のテンプレートを適宜修正してください。
- 明確で簡潔な説明を心がけ、レビューアーが理解しやすい内容にしてください。