Open1
商用サービスから学ぶ【プルリクエスト】の書き方
Kohki_Takatamaはじめに
こちらの記事「【無料公開】560万円かけて開発したサービスのソースコード」から、
商用サービスのプルリクエストはどう書かれているのかを見ていきます。
※以下、「PR」はプルリクエストを指します。
プルリクエストに書かれていること
こちらのURLのPRを例に取ります。
タイトル：「接頭辞: タイトル」
このPRではfeat: deploy actionsと書かれています。
featは接頭辞（prefix）と呼ばれるもので、PR / Commitを分類するものです。
「新しい機能やファイルを追加した」ことを示します。
接頭辞をつけることで、ひと目でわかりやすいPR / Commitになります。
やりたかったこと
簡潔に「何をやりたかった」が書かれています。
「目的」と「結果」は時として混在しがちです。
「目的」を簡潔に示すことで、この後の「やったこと」「やらなかったこと」の意図が共有しやすくなりそうです。
やったこと
何をやったのか、詳細に丁寧に書かれています。
レビューがしやすそうです。
やらなかったこと
これも同様に、レビューがしやすそうです。
要不要の認識に齟齬があれば、ここで指摘してもらえますね。
ユーザ視点での変更
これはリリースノートなどに関わるところでしょうか。
個人的には、この項目を書くことによる「自分の理解が深まること」のメリットを感じます。
影響範囲
これもレビュー対象になるのでしょうか。非常に理解を試される項目です。
動作確認視点
動作確認、大事なことですね。
issue
fix #numでissueと関連付け、PRと同時にクローズすることができます。
その他
申し送り事項があればここに書くということですね。
柔軟です。
まとめ
以下の項目がありました。
PRの参考にさせていただきます。
- タイトルの接頭辞
- やりたかったこと
- やったこと
- やらなかったこと
- ユーザ視点での変更
- 影響範囲
- 動作確認視点
- issue
- その他