タグ

ブックマーク / chiastolite.hatenablog.com (1)

  • よいコミットメッセージとはどういうものだろう? - chiastolite’s blog

    tl;dr なぜ「私たちは」これをしたのか?の理由を書こう コミットメッセージといえば t_wada さんのツイートがよく引用されている コードには How テストコードには What コミットログには Why コードコメントには Why not を書こうという話をした— Takuto Wada (@t_wada) September 5, 2017 自分もこの考えに賛同してるので、コミットメッセージにはWhyを書くし書いて欲しいと思う。 では「Whyを書く」とはどういうことだろう? 「レビューで指摘された内容を反映した」 みたいなコミットメッセージを何度か見て頭をかかえたことがある。 「なぜこのコードを書いた」の理由ではあるので日語としては間違っていないコミットメッセージではあるのだが、決してこの内容は欲しい情報ではない。 これならレビューで指摘された内容をコピペしてもらったほうがあり

    よいコミットメッセージとはどういうものだろう? - chiastolite’s blog
    d4-1977
    d4-1977 2019/08/27
    コミットメッセージ、コードに何が起きたか?を書くことを考えているけれど、普段は出来ていないかもなあ…という気持ち🙇🏻‍♂️あと、スカッシュマージで、プルリクに書いていて、そっち見てたりします
  • 1