これは何？
自分はレビューコメントにラベルをつけます。
時にコメントを沢山するかもしれませんが、レビューイには状況に応じて優先度を決めて対応して欲しいです。
そこで、自分がレビューで使うラベルとそれぞれの意図をまとめました。
僕のレビューで使うラベルとそれぞれの意図
| ラベル | 意図 | 対応が必須かどうか |
|---|---|---|
| MUST | 必ず対応して欲しい！ | 必須 |
| ASK | 実装意図の確認 | 必須 |
| IMO | 自分ならこう実装するけどどう？ | 任意 |
| nits | 細かい指摘 | 任意 |
| mono | 独り言。自分用のメモ | 無視してOK |
MUST
対応してもらわないとマージできない。
ex)
明らかに既存のアーキテクチャとずれている。
セキュリティホールがあり、本番反映されるとまずい。
ASK
要件の確認や実装意図の確認。
レビューをする上で分からないことがあるので教えて欲しい。
レビューの精度に繋がるため、解決するまでマージは出来ない。
IMO
In My Opinion
自分が考える実装を提案する時に使う。
自分の好みが反映されている場合が多い。
マージを優先したい場合は無視しても大丈夫。
nits
些細な指摘。余裕があれば直して欲しい。
ex)
インデントやタイポ
mono
レビュー中の自分のメモ。
無視してもらって大丈夫です。