コードレビューの nit の意味

コードレビューのコメントに記述されることがある「nit」ですが、これは「nitpicking(つまらぬあら探し)」の略語です。

 

コメントに「nit」が付与されている場合、「細かいところを指摘するようだけど ... あなたの判断で、これについては必ずしもコードを修正する必要はないですよ」という意味になります。

 

コードレビューの不要な混乱を避けるためには、定義を正しくしておくことは大切だと思います。日本人には謙虚な心がありますが、控えめな気持ちを表現するために「nit」を書き込むのは止めたほうが良いでしょう。

 

コードレビューにかかる開発者それぞれの負担を、可能な限り小さくすることは大切で、そのためにも問題への明確な指摘とは区別して、必ず修正する必要はないけれど可能であれば変更を検討してほしいことを「nit」として伝えるべきでしょう。

 

よくあるのが「nit」と書かれていても、結局は毎回すべてのコメントに対応してしまっているという状況です。この場合は「nit」とその他のコメントに、実質的な区別がなく、意味がありません(謙虚さは伝わるかも知れませんが、それなら「nit」を使う必要があるでしょうか?)。

 

参考文献:
The Standard of Code Review | eng-practices

Reviewers should always feel free to leave comments expressing that something could be better, but if it’s not very important, prefix it with something like “Nit: “ to let the author know that it’s just a point of polish that they could choose to ignore.

レビュー担当者は何か良くできそうなものがあれば、いつでも気軽にコメントの残すことが出来ます。しかしもし、あなたのコメントが重要でないならば、例えば「Nit:」のようなものをコメントに付与して、よりコードを磨き上げることは可能だが、無視しても構わないということを伝えることもできます。