状況
PR に対して、バグにつながる指摘と、好みの範囲の命名についての指摘の両方を書こうとしている。
コメントの書き方として適切なのは?
正答
- 命名の指摘には「Nit:」を付け、修正必須の指摘と区別する
- どちらも同じ重さで書き、どれを直すかは作成者に任せる
- 好みの指摘も含めて、すべて修正必須として書いておく
- 命名の指摘のほうが多いので、バグの指摘は口頭で伝える
解説
指摘の重さが区別されていないと、作成者は細かい命名の修正に時間を使い、本当に直すべきバグを後回しにするおそれがある。好みの範囲の指摘には「Nit:」(細かい点)などを付け、修正必須の指摘と分けるのが一般的。すべてを必須にすると、レビューが好みの押し付けになる。重要な指摘を口頭だけで伝えると記録に残らず、対応漏れの原因になる。
参考: google.github.io
この問題を含む 実務シチュエーション のテストを制限時間つきで解く
実務シチュエーションクイズへ