読者です 読者をやめる 読者になる 読者になる

わすれっぽいきみえ

みらいのじぶんにやさしくしてやる

コードレビューの見出しのフォーマットについて

GitHubに限らずコードレビューを行う際は例えばPull Requestなら一体何を解決するためのPRなのか簡単でいいから書いて欲しいと思っていて、何のdescriptionもなくいきなりリンクだけ貼られて「はい、レビューしろ」っていうのは失礼だなとさえ思う。

でもこの辺ってチームの文化とか慣れとかでだんだんなぁなぁになるのかなとも思ってるんで、最低限自分が決めているフォーマットを結構前からgistにおいてる。

gist.github.com

たったこれだけしかない。けど、このたったこれだけがあるのとないのとでだいぶ違うと思っている。

Pull Request のフォーマットを決めるとレビューの効率が3倍よくなる :: Crocos Engineering Blog にあるくらいガチガチに書くのは結構description書くだけで骨が折れるので、よっぽど周りに突っ込まれたくない時くらいしかやらないなぁと思ってる。まぁ書きすぎて逆に突っ込まれそうでもあるがw

上に貼ったフォーマットはものすごく簡略化されてるけど、簡単だからこそ継続しやすい。あと自分がこれをずっとやってるとフォーマットこそ微妙に違うものの、チーム内で「何も書かないのはまずいかな?」という雰囲気がちょっと出るので良いと思ってる。

もっといいフォーマットあったら教えてください。

2017-01-30 追記

ブクマコメントより

タイトルで概要が伝わらないならちょっと辛い。

本当にその通りだと思う。本当ならタイトル自体をいい感じにするべきなので、ちゃんとチームでのPRのタイトルの運用についても揉んだほうがいい。