よく使うレビューコメントのプレフィックスまとめ

#GitHub

morimorikochan

2023.07.07

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは、morimorikochanです。

入社して早速ですが、担当する案件で開発をやっています！そして他のエンジニアのレビューをすることになりました。が、今まで自分が使っていたレビューコメントにプレフィックスをつける運用を他のエンジニアに一切共有していなかったので、この運用をこの際DevelopersIOにブログとして挙げようと思います

レビューコメントのプレフィックスとは？

レビューコメントの先頭につける特定のプレフィックス文字 [xxx] です。例えば以下のようなコメントの先頭部分です。

[ask] ここってどういう原理でフィルタリングされてるんですか？

このプレフィックスがあると何が嬉しいかというと、コメントの意図を正しく伝えられます。
例えばレビューをしていると、

修正して欲しい意図はないただの質問なのにレビュイーが勘繰ってしまって不必要な修正をしてしまったり
レビュイーに修正の必要性が伝わらず修正不要と判断されてしまったり

することがあると思います。
どのぐらいの温度感のレビューコメントであるかをプレフィックスに明示することで、これらの問題を解決することが狙いです。

また、副次的ですが、ルールがあることによってレビュワーがレビューコメントを書く時間/レビュイーが読む時間の双方を短縮してくれることも嬉しい点ですね！

プレフィックスにはどういう種類がある？

一部オレオレルールになってます。だいたいこのぐらいの数があれば表現できるなと感じてます

プレフィックス	意味
must	必ず修正して欲しいと考えている
want	修正して欲しいと考えている
imo	自分の意見としては修正した方が良いと感じている（他の人も多分そうかも）
imho	自分の意見としては修正した方が良いと感じている（他の人は違うかも）
nits	些細な問題。重箱の隅をつつくレベルだが修正した方が良いかなーと感じてる
info	ただのアドバイスや共有事項。このプルリクエストで修正して欲しいとは思ってないがこれから気をつけるともっと良くなると感じている
ask	単純に質問。修正して欲しいとは思ってない。意見交換

特にinfoとaskがあるおかげで、修正の必要有無を簡潔に伝えられる点はとても有用です。

ちなみに

プレフィックス関係ないですが、レビューコメントを書く上でめちゃくちゃ大事なことがあります。
それは、修正する必要があるならなぜ修正した方が良いか（+どう修正すれば良さそうだと考えてるか）を明確にすることです。
例えばコメントに[must]がついてるが修正の必要性がわからないと困りますし、コメントをもう一往復させる必要があります。

そういうことがないように、コメントにはなぜ修正した方が良い（+どう修正すれば良さそうだと考えてるか）を明確にしていきましょう（自戒を込めて）