よいコミットメッセージを書くために心がけていること - くりにっき
よいコミットメッセージとはどういうものだろう？ - chiastolite’s blog に対するアンサーソングです chiastolite.hatenablog.com 必要であればWhyを補足するためのContextを書く 元エントリだとコミットメッセージの話だったけど僕はPRで実践してもいいと思います。*1 起点となるURLを明記する レビューで指摘されたのであればPRのコメントのURL issueのURL アプリケーションエラーであればSentryなどのエラートラッキングシステムのURL GitHub外のタスク管理ツール（例：redmineやBacklogやTrelloなど）に修正概要が書かれているのであればそのURL チャットのやり取りが起因ならSlackなどのパーマリンク 公式ドキュメントのURL CIがコケているのであればCIのビルドのURL チーム開発していればコミットやP
よいコミットメッセージとはどういうものだろう？ - chiastolite’s blog
tl;dr なぜ「私たちは」これをしたのか？の理由を書こう コミットメッセージといえば t_wada さんのツイートがよく引用されている コードには How テストコードには What コミットログには Why コードコメントには Why not を書こうという話をした— Takuto Wada (@t_wada) September 5, 2017 自分もこの考えに賛同してるので、コミットメッセージにはWhyを書くし書いて欲しいと思う。 では「Whyを書く」とはどういうことだろう？ 「レビューで指摘された内容を反映した」 みたいなコミットメッセージを何度か見て頭をかかえたことがある。 「なぜこのコードを書いた」の理由ではあるので日本語としては間違っていないコミットメッセージではあるのだが、決してこの内容は欲しい情報ではない。 これならレビューで指摘された内容をコピペしてもらったほうがあり
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
