【レビュー依頼】MR・PRの書き方、出し方
適切にブランチを設定する
これもチームによりますが一応。
全部masterにというのは基本的にはないと思います。どのようなブランチの運用をしているかわかりませんが、developなどがマージ先になることが多いかと思います。
もし、今作業しているブランチAからさらにブランチBを切って作業する場合を考えます。
ブランチBのMRを作成するときは、差分としてブランチAからの差分を見せられるようにした方が、レビュアーはレビューしやすいと思います。
説明の記入
こちらは基本的には以下の項目を書き込みます。
- 変更の目的(why)
- 変更の内容(what)
- どのように変更したか(How) →主にスクリーンショット
- ※もしかけるなら、変更によって期待される成果
基本的には、5w1hに則って、記載します。
ただ5wのうちwhenとwhereはMRを出した時間と、whereは差分を見ればわかるので、大丈夫。
あとは、目的や内容を書きます。
そんなにつらつらと書かなくても、スクリーンショットや動画があると、レビュアーとしてはわかりやすいです。
Assigneesを設定する
関連する人は入れておいた方いいです。
5w1hの中のwhoに該当する項目ですね。
とりあえずDraft：、[WIP]にしてMRを作成する
基本的には、完璧だと思っても、Draft状態にして作成します。
fileのdiffを見直すとコメントが残ったままだったり、間違っている部分があったり、修正が必要なところがあるのが普通です。
また、もしDraftをつけずにMRを出してしまった場合、レビュアーがすぐに見てくれる可能性もあります。
とにかくまずはDraft状態でMRを作るのが基本です。
PR作成後にコードにコメントを記入する
ぱっと見わからなそうなところには自分でコメントを入れます。
特に実装の際に迷った部分などには、わからなかった旨をコメントしていきます。
Draftを外して、レビュー依頼をする
レビュー依頼しましょう。
Draft状態を解除して、レビュー依頼をします。
