コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

レビューコメントの意味通りを良くするためのヘッダTips

よくコードレビュー事例で『そのコメントの最初に [MUST] [MAY] とかをつけることにより対応の度合いを説明できる』 みたいな事例を見るけど、どういうのがあるのかの事例集。

英語パターン

MUST

必ず直して欲しい部分に関して使う。RailsでいうところのN+1が起きてるよ的な。

IMO(In My Option)

訳すると「私の考え」という訳になる、日本語であれば「提案」「参考」「おまかせ」などが近い表現になる。

NITS(nitpick)

細かい指摘、タイポやインデントミスのようなものに使う。些細なことだけど直して欲しいみたいな気遣い

ASK

質問。単純に疑問やどういう仕様なのかを聞きたいときに使う。

関連リンク