エンジニア

コードレビューコメントを作るプロンプト

Pull Requestのレビューをしていて、「この指摘、どう表現すれば角が立たずに伝わるだろう」と文面を考えるのに時間がかかった経験はないでしょうか。技術的には正しい指摘でも、伝え方次第で相手の受け取り方が大きく変わります。

このプロンプトは、指摘したい技術的な内容とニュアンスを伝えるだけで、AIに建設的なレビューコメントの文面を作成させるものです。コピーしてそのままChatGPTやGeminiなどに貼り付けて使えます。

コピペ用プロンプト

以下のコードブロックの中身をそのままコピーして、AIチャットに貼り付けてください。【 】で囲まれた部分はご自身の状況に合わせて書き換えてください。

あなたは経験豊富なテックリードです。以下の情報をもとに、コードレビューのコメント文面を作成してください。

【指摘したい内容(技術的な問題点)】: ループの中でデータベースへの問い合わせを毎回実行しており、N+1問題が発生している
【コメントのニュアンス】: 必須の修正依頼(Must)
【レビュー相手との関係性】: 後輩・経験の浅いメンバー
【補足したい背景(なぜ気になったか)】: データ件数が増えるとパフォーマンスに影響が出る可能性がある

# 出力してほしい内容
1. コードレビューコメントの文面(1〜2文で要点を伝え、必要なら改善の方向性も添える)
2. コメントに添えるとよい参考情報(関連するアンチパターンの名称など、あれば)

# 制約条件
- 相手の実装を頭ごなしに否定する表現は避け、「〜だと更に良さそうです」等の建設的な言い回しにする
- 必須修正の場合は、その旨が明確に伝わるようにする(絵文字や「(Must)」などのラベルを使ってもよい)

使い方3ステップ

  1. 上記プロンプト内の【指摘したい内容(技術的な問題点)】【コメントのニュアンス】【レビュー相手との関係性】【補足したい背景】を、実際に指摘したい内容に書き換えます。
  2. ChatGPTやGeminiなどのAIチャットに貼り付けて送信します。
  3. 出力された文面を実際のPull Requestのレビューコメントとして投稿します(必要に応じて自分の言葉で微調整)。

入力例と出力サンプル

入力例(ニュアンスを変更した場合)

【指摘したい内容(技術的な問題点)】: エラーハンドリングがtry-catchで握りつぶされており、エラー内容がログに残っていない
【コメントのニュアンス】: 質問・確認(意図を確認したい)
【レビュー相手との関係性】: 同僚(対等な関係)
【補足したい背景(なぜ気になったか)】: 障害調査の際に原因特定が難しくなる懸念がある

出力サンプル(抜粋)

このtry-catchでエラーを握りつぶしている部分、あえてログを出さない意図があれば教えていただきたいです。もし特に意図がなければ、障害調査のときに困りそうなので、ログ出力を追加しておくと安心かもと思いました 🙏

カスタマイズのコツ

  • 「Must」「Should」「Nice to have」等のラベルを使う文化のチームであれば、【コメントのニュアンス】に応じてラベルを付けるよう出力フォーマットに追記するとよいでしょう。
  • 良い実装への称賛コメントを作りたい場合も、同じ形式で「褒めたい点」を指摘内容として入力すれば使えます。
  • チームのレビュー文化(絵文字を使う、Nitpickの表記を使う等)があれば、制約条件に追記すると文化に合った文面になります。

注意点

  • 生成されたコメントは投稿前に必ず内容を確認し、技術的な指摘として正確かどうか自分でも判断してから使用してください。
  • 実際のコードの中身(社外秘のロジックや機密情報を含むコード)を丸ごとプロンプトに貼り付けないよう注意してください。
  • 相手との関係性や過去のやり取りの文脈まではAIが把握できないため、最終的なトーンの調整は自分で行ってください。