🌊

コードレビューするときに、疑問形だけで終わらないようにしたほうがいいかもしれない

2022/07/27に公開

TL;DR

  • レビュワーは確認の意図で疑問形だけで記載すると、批判に見える可能性があるので、疑問形だけで終わらない方がいい
  • 疑問形で書く場合は、必ず意見・前提・意図も一緒に入れること

背景

  • コードレビューするときに、よく相手の実装意図を確認するために、このようなコメントをしてしまっていた。
ASK
こちらの修正ですが、~というエラーについての原因は調査されましたでしょうか?

問題

  • レビューを受ける人からすると、批判されているのかただ意図を確認しようとしているのか判断しづらいので、コミュニケーションしづらいかもしれない。

  • 確認しているだけなのに批判されている、っと感じ取られると、社内全体がぎすぎすした雰囲気になるかもしれない。
  • また、この場合レビューを受ける人からすると、その質問に対して回答した後にレビュワーの回答を待たなければいけないので、時間の無駄になる。
  • 心理的安全性的にもあまりよくない。

解決方法(というかより働きやすいレビューにするために)

  • 質問の場合、質問の背景をちゃんと書く
    • 指摘なの?
    • 前提確認なの?
  • ASK, MUST, IMO など、自分自身の意図が分かりやすいようなコミュニケーションルールを社内に整備する
ASK
こちらの修正ですが、~というエラーについての原因は調査されましたでしょうか?
というのも、このエラーの原因は個人的にはxxxなのではないかと考えていて、
もしそうなのであればyyyも影響する可能性があると思ったので、実装としては以下のようなモノがいいかと思いました。

//hogefuga code

Discussion