Pull Request のコメント数を減らすアホみたいなコツ｜牛尾 剛

私は長年 Pull Request のコメント数が多くて何回もレビューを往復することが多くて大変つらかったが最近ものすごく単純なコツに最近きづいたのでそのことをシェアしようと思う。 Pull Requestレビューの悩みこれはならない人はならないので、共感してもらえる人は少ないかもしれないが自分の悩みは Pull Requestのコメント数でこれが本当に多い。何がつらいって、レビューのコメントが多いという事は、マージに時間が掛かるということだ。最初にコードを書いてテストして完成させるのは２時間もかかってないのに大抵レビューで何往復もして時間を取られるのが本当につらいし、進捗がでないもの嫌だし、時間かかるし、自分が最近解決したい問題の中でも筆頭の問題だった。 何が悪いのだろう？すごく嫌なので物凄く考えたがうまくいかなかった。例えば、英語のスペルミスも良くしたし、ログやコメントの英文にレビュー

[n_231]

「下まで読めば分かるのに」と「下まで読まなきゃ分からない」の間に深い溝がある。コード読み手の認知負荷がボトルネックとなる場合は多い。

[hase0510]

プログラマー視点の話なのかレビュワー視点の話なのか、しばらく読み進めないとはっきりしなかった。つまりそういうことなんですよねぇ。

[NOV1975]

文化がよくわからん。コードがポンコツすぎてせめて補助線引いてくれよじゃない限りレビュアーの責務ってコードの正しさを確認することだと思うので下まで読めよって思うが。（その上でコメント書いとけ、ならわかる

[sigwyg]

レビュアーなら下まで読めよ、はその通りなんだけど、レビューにめちゃくちゃ時間が掛かるようになってしまうからな。

[Iridium]

何を書いてあるかわかって読んでいくのと、それを推測しながら読むのとでは負荷がぜんぜん違うんだよ。

[kazkaz03]

“読者に「なんでここはこうなってるのだろう」と思わせたら終わりだ。”

[ka-ka_xyz]

"レビューをそのまま実装しようと考えると、「コードは読み物」のマインドセットがあっても、コードが歪んでしまうことがある。""ゼロから考えて「読み物」のコードを書いていこう。" あー、わかるわかるこれはわかる

[circled]

つ https://whatthediff.ai/

[Magicant]

ベテランの人でもかういふことに気付くのに何年もかかったりするので人の成長といふのは人それぞれなんやなあ

[Falky]

コードも悪かったんだろうなと思うけど、レビュワーも悪い。理由も述べずに「〇〇しろ」だけ、みたいなコメントはrejectというルールでいいと思うが。

[God-kami]

“コードは書くものではなく読まれるものだ。”

[koogawa]

ぜんぜんアホみたいじゃなかった

[tadyjp]

とても胸に刺さる

[gyampy]

仕事ができるというのは、他の人が「何がわからないと思う」のかを知って、気を配るということなのだと思う。レビューをそのまま実行するんじゃなくて、その意味を理解しようとする姿勢を持ってる人は優秀

[manhole]

“コードの読みやすさは時代とともに進化するので、キャッチアップをわすれずに楽しもう”

[noritada]

“リーダブルコードや、リファクタリングなどの本は良い本だがいかんせん古い。” 学び直しが必要か。

[munieru_jp]

唐突に出てくるクリスって誰なんだ……

[a-kuma3]

裏側に "読みづらいコードには、たいてい地雷が埋まってる" という経験則があるからでしょう。LINQ (Lambda) に if の分岐があったら、普通の人は突っ込む。その Lambda のテストコードはないわけだから

[kubecorn]

“読者に「なんでここはこうなってるのだろう」と思わせたら終わりだ。”珍しく同意。レビュアーや後の運用時に触る人に全部読むことを求めていたらとんでもない生産性になる。

[tg30yen]

レビュアーは当然下まで読むよ。そういうことじゃなくて他のメンバーが必要に応じてそのコードを読むときにいかに早く理解できるかということなんだよ。

[kuwayoshi]

コードは読み物って、そのまんまリーダブルコードなんだな。把握しやすい ＞ 読みやすい ＞ 書きやすい。ということかな。

[tockri]

ぜんぜんアホみたいじゃない、けどそこを気にして指摘してくれるレビュアーがいっぱいいるのっていい環境だなあ。

[PrivateIntMain]

驚き最小の原則の話かな。最適化するにしても、//後からこういうことしたいからこうしとく と書いてあるだけでへぇと思って読み進められる。

[khtokage]

周りがバカに見えてるとき一番バカなのは自分という、いわゆる「バカの壁」に囲まれてる状態ですね。　「バカの壁」は一度克服しても何か学ぶ度に発生するのが難しい。周りが馬鹿に見えたら注意するしかないですね。

[diveintounlimit]

イケア効果かな。あと指示だけコメントしちゃうのは、それを書く側の問題もある。とりあえず記載内容からは、この人のITエンジニアとしてのスキルは自分で思ってるよりは低そうだ。

[mumei-0]

“Pull Request のイテレーションを短くしたかったら、コードは「読み物」と思って書こう。”

[AKIIRA]

"読み物と考えるといろいろ変わってくる。本と同じだ。","コードの読みやすさは時代とともに進化する"

[namisk]

余計な疑問をメモリに積みながら細かいブロックの中身まで注意深く読まなきゃいけないとめんどいね。4名以上のメンバーから日々プルリク送られるような立場だとやってらんないってなると思う。

[snowcrush]

良記事だと思った。書くときは読みやすさに気をつけていてもいざレビューになればギャップが生まれがちなので相手の理解度に合わせる視点は忘れないようにしたい。

[jiro68]

毎日多くの PR が来る人にとっては1つ1つのPRを詳細にレビュー出来ないだろうから、下まで読まずに目に付いた事をコメントするのは理解出来る。プロなら分かりやすいコードを書けという事。コードは自分のものではない

[kagerouttepaso]

このくらい当然でしょ？の意識のままでレビュアーになると独善的になるから多様な視点を持たないと危険って自分の失敗を思い出した。