AIが書いた重厚なプルリク説明文、読んでますか？

Claude Code や Codex 等の AI にプルリク（以下、PR）を書かせて効率化することができます。
けれど、その書かれたプルリク説明文、ちゃんと全部読んでいますか？
レビュワーの負担になっていませんか？

ノイズが多い

プルリクエストの雛形を使って、PR説明文のフォーマットを決めることができます。
例えば、変更内容というセクションがフォーマットにあったとします。
その変更内容には、コード変更の要約についてのコメントが書かれていることが多いです。
変更内容は具体的なテキストデータ(git diff)があるので、めちゃくちゃ饒舌に書かれていることがあります。

確かにありがたいときもあるのですが、私の経験上だとあまり参考になることが少なかったです。
実際のコード変更を見る方が手っ取り早いです。（どこから読み始めたら良いか？ぐらいは欲しいかも）

読まない大量のテキストがあると本来読むべき箇所を探し出すのに手間になります。
AI に書かせるのは便利なので良いのですが、情報整理して断捨離 した方がよさそうです。

なぜ変更したかがない

変更内容の説明はあるのですが、なぜ変更したかという情報はあまり見当たりません。
どういう課題があるのか、モチベーションは何か、背景として何があるのか、などの方がレビュワーは気になります。
How の部分の大量の説明よりも、Why の説明の方が大事な気がします。
その Why があった上で、課題解決するため もしくは解決するための準備などの PRだと分かれば、より妥当なレビューができそうです。

以下の簡単な雛形で、私は十分と思っています。

## 背景・モチベーション・課題
 
<なぜPRを作成したかのコメント>
 
## 変更内容
 
<前項の問題を解決する変更内容をコメント>
 
## 動作確認
 
<プロダクトに応じた動作確認コメント>

知らない単語がある

AI が書くPR説明文は、コード変更内容を日本語に翻訳されることがあります。(指示による)
たまに、それってどういう意味の単語？となったりします。
ドメインによって決まった用語があると思うので、それと紐付けれるような PR説明文が欲しいです。

レビューも AI に任せれば？

AI 推しの方だと、レビューも AI に全部任せるというアイデアがありそうです。
それで保守運用が継続できる見込みがあるなら構わないのですが、現実的には難しいかもしれません。

機械的に分かる範囲のレビュー（タイポや規約違反）や技術スタックならではの非機能要件のチェッカーには、 AI レビューは強そうです。
プロダクトの機能開発や改善活動のように、さまざまな側面を配慮しながらのレビューは、たぶんまだ 人間がしないと難しそうです。
『ここを修正する場合、連携先のxxxシステムの影響範囲は大丈夫だろうか』
『ここを修正する場合、とある特殊条件下での動作は大丈夫だろうか』
『ここを修正する場合、エンドユーザーへのアナウンスはできているだろうか』

終わりに

AI に書かせるのは便利なのですが、ちゃんと自身が提出する PR だという認識を持ちましょう。
その PR説明文は将来の自分自身が読んでも理解できるものなのか、丸々鵜呑みしないようにしましょう。

記事をシェアする

Xで記事をシェアするBlueskyで記事をシェアするはてなブックマークで記事をシェアするデバイスで記事をシェアする記事のリンクをコピー

筆者をフォローする

Xで筆者をフォローするBlueskyで筆者をフォローするGitHubで筆者をフォローする

ブログの読者になる

RSSでブログの更新を受け取るメールでブログの更新を受け取る

ブログを応援する

OFUSEで応援を送る