背景
OJTが始まって2か月、少しずつ難易度が高いタスクに着手していく中で、プルリクのレビューで質問や指摘などのコメントをたくさんいただくようになった。中にはコード整形の依頼やコメントのつけ忘れなど、レビューを依頼する前に最低限自分で確認しなくてはいけないような些細な事までレビュアーに指摘させてしまい、余計な時間を使わせてしまったと反省した。
そのため、レビュイーとして依頼をする前に最低限自分で確認しておくことと、チームメンバーのレビューの仕方を参考に今後自分がレビューする側になったときに意識したい事をまとめておくことにした。
(実務経験1ヶ月時点での視点なので、今後も随時アップデートしていく)
レビュイーとしてコードレビューを依頼する際に意識すること
■編集を加えた箇所を上からざっと見直す
そして見直す際に以下のことを確認する
- コード整形はしたか？
- 適切なコメントは入れたか？
- 不要なimport文はないか？
■実装・修正した箇所について説明ができる状態である
具体的には以下のことを自分の口で説明できるようにしておく
- 機能仕様・このタスクで実現したいこと
- 実現のために行った修正や実装
- なぜこの書き方にしたのか（単に知識がなくてこの書き方しかできなかったのか、この書き方が最善だと思う理由があるのか）
- レビュアーから頂きたい意見やアドバイス（あれば）
レビュアーとしてコードをレビューする際に意識すること
■理解ができないコードは遠慮せず質問する
「新人だから、、」とか「こんなのも分からないのって思われそう、、」とか思わず、チームのコード可読性向上のために遠慮せず質問する。
■コメントをする際、コメントの種類・重要度が一目でわかるようにする
略語をうまく活用してレビュイーがぱっと見でコメントの種類を理解できるようにする。
| 略語 | 語源 | 意味 |
|---|---|---|
| MUST | 絶対に読んでほしい・修正してほしい | |
| Want | できれば直してほしいかも | |
| Q | Question | 質問 |
| IMO | In my opinion | 私の意見としては |
| NIT / NITS | Nit(s) pick | 強制ではないが些細な指摘や軽い修正をしてほしい時 |
| FYI | For Your Information | 参考までに (関連記事のリンク張ったり) |
| WIP | Work In Progress | 対応中 |
| LGTM | Looks Good To Me | 自分的にはOKだよ |