機能追加プルリクエストテンプレート
動機、設計判断、実装詳細、機能フラグの検討を含む新機能開発用PRテンプレート。
Specialized Templates
詳細な説明
機能追加PRテンプレート
新機能PRは、動機、設計選択、ロールアウト計画に関する追加のコンテキストが有益です。このテンプレートはコントリビューターがその情報を事前に提供するよう導き、レビュー中のやり取りを減らします。
テンプレート構造
## Feature Description
<!-- この機能は何をしますか?誰のためですか? -->
## Motivation
<!-- なぜこの機能が必要ですか?プロダクトスペックやRFCがあればリンクしてください。 -->
## Design Decisions
<!-- どのような代替案を検討しましたか?なぜこのアプローチを選びましたか? -->
## Type of Change
- [x] New feature
## Implementation Details
<!-- 実装アプローチの概要。 -->
## Checklist
- [ ] プロジェクトのスタイルガイドラインに従っている
- [ ] コードのセルフレビューを実施した
- [ ] 理解しにくい箇所にコメントを追加した
- [ ] ドキュメントに対応する変更を行った
- [ ] 新しい警告が発生しない
- [ ] 機能が動作することを証明するテストを追加した
- [ ] 新規・既存のユニットテストがローカルで通過する
- [ ] 機能フラグを設定した(該当する場合)
- [ ] APIドキュメントを更新した
Design Decisionsセクション
Design Decisionsセクションは機能PRテンプレートの最も価値のある部分の一つです。アーキテクチャ選択の「なぜ」を文書化し、特定のアプローチが採用された理由を疑問に思う将来のメンテナーにとって貴重です。
ロールアウト計画
プログレッシブデリバリーを実践するチームにとって、Rollout Planセクションは機能のリリース方法(機能フラグの背後、ユーザーの一定割合、フルリリース)を捕捉します。リリースマネージャーやオンコールエンジニアにとって重要な情報です。
APIドキュメント
新機能はAPIエンドポイントの導入や変更を伴うことが多く、ドキュメントの更新が忘れられがちです。チェックリストにAPIドキュメントのリマインダーが含まれています。
ユースケース
デザインレビュー、ドキュメント更新、協調ロールアウトが必要なユーザー向け機能を開発するプロダクトエンジニアリングチーム。プロダクトマネージャーやデザイナーがレビュープロセスに参加するチームに特に有用。