Open4

gitでのcommitの考え方

awonosukeawonosuke

commit:この変更セットで間違いないからよろしく、とユーザーが自分の責任をシステムに送る

awonosukeawonosuke

conventional commits入門

  • conventional commitsはOSS開発などで採用されるコミットメッセージ規約
    • 意味のあるコミットメッセージを書くことを目的としている
  • commitメッセージには何を変更したかではなく、その変更を受け入れるとどうなるかを記述する
  • commitメッセージのフォーマットは以下
<type>[optional scope]: <subject>

[optional body]

[optional footer(s)]
  • 各項目の役割(*は必須)
    • *type:変更のカテゴリーを記載、種類はリンクを確認
    • scope:commit対象のコードベース内の領域を記載
    • *subject:commit概要
      • 命令形、現在系の動詞から始める(changes、changedなどは使わない)
      • ピリオドは使わない
    • body:commit本文
    • footer:重大な変更の説明、フォーマットあり
  • body、footerを書くときそれぞれ空行を入れる
  • 重大な変更が行われた時、任意でfix!: hogeのように!を付ける

https://gist.github.com/minop1205/5fc4f6ef0ec89fb1738833ba25ae00a0
https://www.conventionalcommits.org/en/v1.0.0-beta.4/
https://www.conventionalcommits.org/ja/v1.0.0-beta.4/
https://zenn.dev/sumiren/articles/418f593dbbf601
https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional
https://365git.tumblr.com/post/3308646748/writing-git-commit-messages
https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit?usp=sharing
https://speakerdeck.com/cocoeyes02/lets-use-conventional-commits?slide=19