エンジニア英語

レビューコメントの英語:角を立てない書き方と例文

簡単な答え

レビューコメントの英語は、命令ではなく質問や提案の形にすると角が立ちません。「Change this.」より「What do you think about ...?」「Could we ...?」のほうが自然です。重要度は「nit:」「optional:」などのラベルで伝えます。DevlingoはGambit Studioのアプリで、レビューの英語を例文で学べます。

更新日 3 分で読めますGambit Studio

インストールなしで使う →ブラウザで無料、登録不要

やわらかく伝える3つのコツ

  • 人ではなくコードについて書く。Googleのレビューガイドは、相手を傷つけかねない指摘ほど「コードについてコメントし、開発者についてはコメントしない」ことを勧めています(Googleのレビューガイド)。「You forgot ...」より「This is missing ...」。
  • 理由を添える。同じガイドは、なぜその指摘をするのかを説明すると相手が意図を理解しやすい、としています(Googleのレビューガイド)。
  • 重要度を示す。「nit:」(細かい指摘)、「optional:」(任意)、「FYI:」(参考)などのラベルで、直すべきかどうかを明確にします。

提案するときの例文

英語意味
What do you think about extracting this into a helper?これをヘルパーに切り出すのはどうでしょう?
Could we use a map here instead of a loop?ここはループの代わりにmapを使えませんか?
Consider adding a test for the empty case.空の場合のテストを追加することを検討してください。
nit: I'd rename this to isEnabled.nit: isEnabled という名前のほうがいいと思います。
Optional: we could cache this result.任意ですが、この結果はキャッシュできます。

質問するときの例文

英語意味
Just curious, why did you choose this approach?純粋な質問ですが、この方法を選んだ理由は?
Is this check still needed?このチェックはまだ必要ですか?
What happens if user is null here?ここで user が null だとどうなりますか?
Am I missing something, or is this unused?私の見落としでなければ、これは使われていない?

必ず直してほしいときの例文

英語意味
This will break when the list is empty. Could you add a guard?リストが空のときに壊れます。ガードを追加してもらえますか?
We shouldn't log the password here, even in debug mode.デバッグモードでも、ここでパスワードをログに出すべきではありません。
Blocking: this changes the public API, so we need a migration plan.要対応:公開APIが変わるので、移行計画が必要です。

褒めるときの例文

英語意味
Nice catch!よく気づきましたね!
This is much cleaner, thanks!ずっと読みやすくなりました、ありがとう!
Great test coverage.テストがよく網羅されていますね。

コメントに返信するときの例文

英語意味
Good point, fixed.ごもっともです、直しました。
Done in a1b2c3d.a1b2c3dで対応しました。
I'd prefer to keep it as is, because ...…なので、このままにしたいです。
Let's discuss this in a follow-up.これは別途話しましょう。

よく使う略語はLGTM(承認)、nit(細かい指摘)、PTAL(もう一度見てください)、SGTM(いいですね)、IMO(私の意見では)です。

Devlingoで開発現場の英語を1日10フレーズ

コードレビューやプルリクエストの英語は、Gambit StudioのDevlingo(English for Devs)の「Code Review」「Pull Requests」カテゴリで学べます。全12カテゴリ・3,600以上のフレーズを1日10個ずつ、使う場面と発音ガイド、例文つきで。画面表示は英語などで、日本語には対応していません。

出典

  1. Google Engineering Practices「How to write code review comments」

よくある質問

よく聞かれる質問に、出典つきで答えます。

コードレビューで使う英語の略語は?
LGTM(承認)、nit(細かい指摘)、PTAL(再レビュー依頼)、SGTM(同意)、IMO(私の意見では)、WIP(作業中)などです。
レビューコメントで命令形を使うのは失礼?
失礼とまでは言えませんが、きつく聞こえることがあります。「Could we ...?」「What do you think about ...?」のような質問や提案の形が無難です。
英語のレビューコメントの書き方のコツは?
人ではなくコードについて書き、理由を添え、重要度(nit・optional・blocking)を示すことです(Googleのレビューガイド)。
コードレビューとは?
書いたコードを、マージ前にほかの開発者が読んで確認し、改善点を指摘したり承認したりする作業です。

続けて読む

同じアプリのガイドをもっと。手順と出典つき。

Devlingo無料 · iOS 17.0+
インストールなしで使う入手