antimacho.dev
GitHub
Git imageGit

Gitのコミットメッセージの書き方

初回作成: 最終更新:

フォーマット ​

Semantic Commit Messagesに従う。

<Emoji><Type>: #<Issue Number> <Title>

  • 例: ✨feat: #123 ログイン機能の実装をする
  • <Type>と<Title>は必須
  • <Emoji>は任意
  • <Issue Number>は強く推奨
  • Description（スリーライン）は任意

<Emoji> ​

  • Typeをよりカラフルにするため、一目でわかりやすくするために書く
  • gitmojiから選ぶのが便利
gitmoji | An emoji guide for your commit messages
gitmoji | An emoji guide for your commit messages

Gitmoji is an emoji guide for your commit messages. Aims to be a standarization cheatsheet for using emojis on GitHub's commit messages.

gitmoji.dev
gitmoji.dev
  • VSCodeでは下記プラグインを利用すると便利
Gitmoji - Visual Studio Marketplace
Gitmoji - Visual Studio Marketplace

Extension for Visual Studio Code - Gitmoji tool for git commit messages in VSCode

marketplace.visualstudio.com
marketplace.visualstudio.com
md
:tada:         プロジェクト開始 🎉
:bug:          バグ修正 🐛
:sparkles:     新機能の追加 ✨
:zap:          機能追加 ⚡️
:memo:         ドキュメントの追加・修正 📝
:recycle:      リファクタリング ♻️
:fire:         不要機能やファイルの削除 🔥
:construction: 作成途中のコミット 🚧

<Type> ​

  • どんなコミットなのかを一目でわかるようにPrefixとしてコミット種別を書く
  • Semantic Commit Messageと同様の種別を使う
種類ケース
choreタスクファイルなどプロダクションに影響のない修正
docsドキュメントの更新
featユーザー向けの機能の追加や変更
fixユーザー向けの不具合の修正
refactorリファクタリングを目的とした修正
styleフォーマットなどのスタイルに関する修正
testテストコードの追加や修正

<Issue Number> ​

  • そのコミットに紐づくIssue番号を書く
    • リンクになって、トラッキングがしやすいため
  • Issueを作っていないケースやhotfixの場合は省略可

Subject ​

  • 変更内容を書く
  • 現在形（「〇○した」ではなく「〇○する」）で書く
  • 文字数は20～30文字以内が適切

参考 ​