仕事でコードを書くときは大抵 pull request にしてレビュワーに見てくださいって言うことになる。 description には「これをやらないと (今のままでは) こう困る」というのを書くように意識している。
多分こんなことは本やインターネットで無限に言われていると思うけどやっぱりそうだなと思って書く。
pull request をつくった身からするとどうしても変更に意識がいきがちで、「これがやりたい」「ここをこう変えた」ということを description にまず書くのだけど、レビューする立場から見ると「今の何がいけないのか」がわからない。変更しなくて済むならそれが一番*1なので、いや〜どうしても変えないと困るんですよね、という点を理解したい。
なので、 (さっきまず書いた内容に加えて) 「今のこれが壊れてて困る」「これがやりたいけど今のこの機能だとこれが足りない」みたいなことをなんとかして書くことにしている。実際それを書こうとして、いやよく考えたら今のままで困らないじゃん、ということに気づいたり、指摘できたりすることもある。
これは issue とか相談ごとでも同じだと思っていて、「どう困っているか」さえ書かれていれば、「どうしたいのか」は一緒に考えたらよいので、「どうしたいのか」は別に書かれてなくてもよい (案があるなら書いておくとお得)。あと逆にレビューするときも、「この変更だとこう困るのでこうしませんか」と書けると、お互いに理解できて嬉しいはず。
