Gitコミットメッセージ 整形ツール
Conventional Commits形式のコミットメッセージをGUIで生成。
絵文字・文字数チェック付き。
✨ 生成結果
概要
Conventional Commits仕様に準拠したGitコミットメッセージをGUIで簡単に生成できるツールです。タイプ選択・スコープ設定・Gitmoji絵文字付与・文字数チェックをワンストップで行えます。
入力した内容はすべてブラウザ内のみで処理され、サーバーには送信されません。
使い方
コミットタイプを選択
feat(新機能)、fix(バグ修正)などの11種のタイプから選びます。
件名・本文を入力
Subjectに変更内容を「何を」「なぜ」の観点で簡潔に記述。必要に応じてBodyに詳細を記述します。
コピーして使用
生成されたコミットメッセージをコピーしてgit commitのエディタに貼り付けます。
用語集
- Conventional Commits
- 構造化されたコミットメッセージの仕様。<type>(<scope>): <description>の形式でメッセージを統一し、CHANGELOG自動生成やSemVerの決定に利用できます。
- Gitmoji
- コミットメッセージの先頭に絵文字を付与することで変更の種類を視覚的に示す慣習。✨(feat)🐛(fix)等。
- Subject(件名)
- コミットの1行目。50文字以下推奨。「何を変更したか」を命令形(英語の場合)で簡潔に記述。
- Body(本文)
- コミットの詳細説明。空行を挟んでSubjectの後に記述。1行72文字以下推奨。「なぜ変更したか」を記述。
- Footer(フッター)
- IssueやPRへの参照(Closes #123)やBREAKING CHANGEの詳細を記述するセクション。
- scope(スコープ)
- 変更の影響範囲を示す任意のキーワード。例: feat(auth)であればauth機能に関する変更であることを示す。
- BREAKING CHANGE
- 後方互換性を壊す変更。タイプに!を付けるか、FooterにBREAKING CHANGE:と記述して明示する。
- SemVer
- Semantic Versioningの略。Conventional Commitsと組み合わせるとconventional-changelogでバージョン自動決定が可能。
FAQ
- Q.入力内容はサーバーに送信されますか?
- いいえ。すべてブラウザ内で生成されます。コードの内容が外部に漏れることはありません。
- Q.カスタムタイプを追加できますか?
- 本ツールはConventional Commits標準の11タイプに対応しています。カスタムタイプはテキスト直接入力でご対応ください。
- Q.Git hookと組み合わせて使えますか?
- commit-msgフックでコミットメッセージの形式をチェックするcommitlintと本ツールを組み合わせることで、チーム全体でConventional Commitsを徹底できます。
- Q.VSCodeでも同様のことができますか?
- VSCodeのCommitizen拡張機能も同様の機能を提供します。本ツールはブラウザ上で即利用できる手軽さが利点です。
- Q.日本語でコミットメッセージを書いても良いですか?
- はい。本ツールは日英どちらにも対応しています。チームの規約に従ってください。
活用シーン
コードレビュー品質向上
統一されたコミットメッセージにより、レビュアーが変更の意図を素早く理解できます。
CHANGELOG自動生成の下準備
Conventional Commits形式で蓄積することで、conventional-changelogでCHANGELOGを自動生成できます。
チームのコミット規約統一
新メンバーにConventional Commitsのフォーマットを学んでもらう教材としても活用できます。
Git初学者の学習
コミットメッセージの書き方を体系的に学べます。