nitの意味と使う場面
英語のnitは、もともと「シラミの卵」のこと。そこから nitpick(細かいことにケチをつける)、nitpicking(あら探し)、nitpicky(重箱の隅をつつくような)という言葉が生まれました。日常会話では少し否定的な言葉ですが、コードレビューの「nit:」は、自分の指摘の重みを下げて伝える気づかいの表現です。
Googleのコードレビューガイドも、コメントに重要度のラベルをつけることを勧め、その例に「Nit: 小さなこと。本来は直したほうがいいが、大きな影響はない」を挙げています(Googleのレビューガイド)。
nitの使い方(例文)
| 英語 | 意味 |
|---|---|
| nit: typo in the comment ("recieve" → "receive"). | nit: コメントにタイプミスがあります。 |
nit: I'd rename this to userCount. | nit: userCount という名前のほうがいいと思います。 |
| nit: extra blank line here. | nit: ここに余分な空行があります。 |
| Nit, non-blocking: we could use an early return here. | nitなので必須ではありませんが、ここは早期リターンにできます。 |
| Just nits. LGTM otherwise. | 細かい指摘だけです。それ以外はLGTMです。 |
nitと言われたときの返し方
直したら「Fixed, thanks!」や「Good catch, done.」。今回は直さないなら「I'll leave this as is for now.」、別のPRで対応するなら「I'll handle it in a follow-up PR.」と返します。nitは任意なので、直さないこと自体は失礼ではありません。
nit以外の重要度ラベル
| ラベル | 意味 |
|---|---|
| Nit: | 小さなこと。直したほうがいいが、影響は大きくない |
| Optional: / Consider: | いい考えだと思うが、必須ではない |
| FYI: | このPRで対応しなくていい。今後の参考に |
| Blocking: | マージ前に必ず対応してほしい(チームによって使う) |
Nit・Optional(Consider)・FYIの3つは、Googleのレビューガイドに例として載っているラベルです(Googleのレビューガイド)。
あわせて覚えたい英語の略語
| 略語 | 意味 |
|---|---|
| LGTM | Looks good to me:いいと思います(レビューの承認) |
| WIP | Work in progress:作業中 |
| AFAIK | As far as I know:私の知る限り |
| TL;DR | Too long; didn't read:要約すると |
| ACK | Acknowledged:了解、受け取りました |
40の略語をまとめたビジネス・チャットで使う英語の略語一覧もあります。
Devlingoで開発現場の英語を1日10フレーズ
コードレビューやプルリクエストの英語は、Gambit StudioのDevlingo(English for Devs)の「Code Review」「Pull Requests」カテゴリで学べます。全12カテゴリ・3,600以上のフレーズを1日10個ずつ、使う場面と発音ガイド、例文つきで。画面表示は英語などで、日本語には対応していません。