プルリクエスト作成
プルリクエストの質を高めることで、将来発生しうるバグの回避やバグの早期発見・改修につなげることができます。
当社ではプルリクエストの質を高め、標準化するため、プルリクエストに記載する観点を明確にし、標準的な確認項目リストを定めています。
プルリクエスト作成の際の行動指針
プルリクエストを作成する際は、下記の観点を含めて作成します。
プルリクエストサンプルと併せて確認しましょう。
- タイトル
- 変更内容
- 変更理由
- 期待値
- エビデンス
- コーディング確認
- 動作確認
タイトル
プルリクエストのタイトルには、対応するBacklogチケットのタイトルをコピー&ペーストします。
フロントエンド(=FE)なのかバックエンド(=BE)なのか、画面実装なのかAPI結合なのかなど、スコープが明確に伝わるタイトルにしましょう。
例
- FE/デザイン/ログイン画面
- FE/ロジック/ログインAPI結合
- BE/API/ログイン
変更内容
修正した不具合や追加した新機能など、変更内容を説明します。
レビュー不要なソース(自動フォーマットによる差分など)がある場合はその旨も記載しましょう。
レビュー不要箇所の記載方法として、該当するソースの箇所へコメントでもOKです。
コーディング確認
観点リスト(プルリクエストサンプル参考)にもとづいて確認し、チェックボックスにチェックします。
未チェックがある場合、レビュアーはレビュー結果NGで返信することになります。
もしチェック不要な項目がある場合は「その他」で理由とともに補足しましょう。
動作確認
観点リスト(プルリクエストサンプル参考)にもとづいて確認し、チェックボックスにチェックします。
未チェックがある場合、レビュアーはレビュー結果NGで返信することになります。
もしチェック不要な項目がある場合は「その他」で理由とともに補足しましょう。