今日の英語表現 14/30 · ステップ: レビューを受ける・返信する。 例文はすべてこの記事のために作成したものです。実際のりポジトリのコメントをそのまま持ってきたものではなく、変数名は例です。
目次
一目でわかる
| 表現 | Nit: ... / nit |
| 意味 | ささいな指摘です: ... |
| 使う場所 | レビューのインラインコメントのプレフィックス |
| 丁寧さ | 柔らかさ。「それほど重要ではない」という配慮が込められています。 |
1. 意味とニュアンス
nitはnitpick（重箱の隅をつつく、ささいなあら探しをする）に由来する言葉です。レビューのコメントの前にNit: をつけると「これはささいな指摘です」という意味になります。タイポ、変数名、空行、コメントの文章など、動作には影響しないものの綺麗に整えるとよい部分に使われます。
Googleのコードレビューガイドラインでは、コメントの重要度を示すプレフィックスとしてNitを例に挙げ、「些細なことである。技術的には直した方がよいが大きな影響はない」という意味だと説明しています。同じガイドラインでは、Optional（またはConsider）やFYIも一緒に紹介しています。このようにプレフィックスをつけることで、作成者はすべてのコメントを必ず直さなければならないと誤解せず、何から対応すべきかを決めることができます。
Nitを受け取った作成者は、大抵修正します。すぐに直せることだからです。ただし、Nitはマージをブロックする指摘ではないため、理由があれば修正せずに短く説明してもかまいません。逆に、レビュアーがNitをあまりに多くつけると作成者が疲弊してしまうため、ささいな指摘を複数集めて「nits」として1つのコメントにまとめることもあります。
第19回のNot a blockerともつながります。「LGTM with a few nits」という言葉は「ささいな点がいくつかあるほかは問題ない」、すなわち大きな問題はないという意味です。
2. 例文
状況 1: レビュアーのインラインコメント
Nit:
cfg→configwould be more consistent with the rest of the package.
状況 2: 作成者の返信
Done, thanks!
Nitに対する返信は短いほど良いです。修正したならDoneやFixedの一言で十分です。
状況 3：修正しないことにする場合
I kept
cfghere because the same name is used in the generated client, and I'd rather not diverge from it. Happy to change it if you feel strongly.
if you feel strongly は「どうしても変更したいのであれば」という意味で、判断をレビュアーに委ねて丁寧に締めくくります。
3. 似た表現との違い
- Optional: / Consider: ... 「良いアイデアだが必須ではない」という提案です。Nit よりも少し重みはありますが、やはりマージをブロックしません。
- FYI: ... 「今回すぐ修正しろということではなく、参考までに知っておくと良い」という情報共有です。
- Super nit / Nitpick. とても些細なことであることをさらに強調します。Super nit はインフォーマルです。
4. 韓国人がよくやりがちなミス
- I'm so sorry for my mistake. I will be more careful. たった一つの Nit に対して過剰に謝罪すると、レビュアーがかえって気詰まりになります。
- 修正後の文：Good catch, fixed.
- 作成者が Nit を 何も返信せずに無視する。 修正しない場合でも、簡単な理由を残すのがマナーです。
- 修正後の文：Leaving this as is to match the existing naming, if that's okay.
- レビュアーになって Nit を付けずに断定的な表現で書く。 You should rename this. は、必ず修正しなければならない指摘のように読めてしまいます。
- 修正後の文：Nit: maybe rename this to
podName?
- 修正後の文：Nit: maybe rename this to
5. 一行プラクティス
レビュアーの立場で、以下の内容をインラインコメントとして書いてみましょう。
些細なことなのですが、このコメントにタイポがあります（recieve を receive に）。
模範解答
Nit: typo, "recieve" → "receive".
Nit のコメントは、文を長くしないのが慣例です。矢印（→）で変更内容を直接示せば十分です。GitHub の suggestion 機能を使えば、作成者がボタン一つで反映することもできます。
ティーティーの一言 Nit は「些細なことである」という配慮です。受け取った側も短く、軽やかに返信すれば大丈夫です。
参考
- Google Engineering Practices, How to write code review comments(Label comment severity): https://google.github.io/eng-practices/review/reviewer/comments.html
- Merriam-Webster, 「nitpick」: https://www.merriam-webster.com/dictionary/nitpick