ブックマーク / zenn.dev/mi0256 (1)

  • ロジカルなコミットメッセージの書き方

    チーム開発におけるコミットメッセージの書き方についてアウトプットします。 コミットメッセージに正解はありません。 組織によって最適な手法は異なるため、参考のひとつにしてください。 要点 フォーマット :Emoji: Title / Reason / Specification / Issue 項目 Emoji - 内容・種類をひと目で分かるように Title - タイトル(概要) Reason - このコミットをする理由 Specification - 言い訳ではなく、このコミット内容になった意図や仕様など Issue - 対応するIssue 作業内容はコードを見ればわかるので、「概要」「変更理由」「意図・仕様」を簡潔にまとめる。 例 コミットメッセージを書く理由 そもそも、コミットメッセージを書く理由は以下の通りです。 ひと目でどんなコミットなのか判断するため 簡潔にコミット内容を説明す

    ロジカルなコミットメッセージの書き方
    shingo-sasaki-0529
    shingo-sasaki-0529 2023/05/15
    本当に綺麗なコミットメッセージは好きよ。でも組織でそれを機械的に強制できて、かつ開発者がストレスを感じにくいフローにできるかと言うと難しそうなので、PR の番号さえあれば後はなんでもいいや。
  • 1