#june29jp

自分の言葉で書かれたコミットメッセージが好き

2017-01-11

140文字には納まらないな、と思ったのでちゃんとエッセイを書く人間になろう!

たとえばぼくがレビューを担当させてもらって「ここはAの方がよいと思いました」とコメントしたとして、そのときに「レビューで指摘された箇所を修正」というメッセージ付きのコミットが追加されたとする。そのあとぼくが思い直して「いや、他の箇所も考慮すると、やっぱりBの方がよさそうです」とコメントしたとする。また「レビューで指摘された箇所を修正」というコミットが追加される。

こういうやりとりだと、「レビュー」というプロセスというよりは「指示」を出している感じになっちゃって、レビューをしているつもりの身としては少し悲しい。そういった感情は抜きにしても、レビュー内容を理解して「うん、その方がよさそうだ」と思っているならそれを言葉にしてほしい。言葉になって出てくれば、レビューで伝えたかった内容がきちんと伝わっているか確認することもできてお得。もし悪さをした中学生を叱ったときに「怒られたのでやめます」と言ってきたら「なにが悪かったのか、理解してもらえたのだろうか…?」と心配になることだろう。あと、指摘されたので修正しました〜というメッセージはあとから見たときに有益になることは少ないと思う。「より意味のある名前に変更する」と書いてあったら有益だ。もし、コミットメッセージを自分の感覚と自分の言葉で書こうとしたときに指が止まってしまうとしたら、その変更の意義をしっかりと理解できていない可能性がある。そうだとしたら、レビューしてくれた人ともう少し丁寧に会話を重ねるのが筋でしょう。

ところで、さっきのツイートをしたら、過去にお仕事でいっしょになったことがある後輩からメンションがきた。ぼくは言ったことを覚えていなかったのだけれど、彼は覚えていてくれてうれしくなった。彼には、ぼくのレビュー内容の意図がしっかり伝わっていたのだと感じられてうれしい。

このエントリーをはてなブックマークに追加