Conventional Commitsの簡易入力ツールが欲しかった

コミットメッセージをいい感じに統一しよう

はじめに

Git を使ったチーム開発で、コミットメッセージの書き方にバラつきがあることに悩んだ経験はありませんか？

「Update って何を？」「Fix だけじゃ意味が分からない」そんなときに役立つのが Conventional Commits という規約です。これは、フォーマット化されたコミットメッセージの書き方を定義し、履歴をより読みやすく、ツールで解析しやすくするための標準です。

しかし、手書きでルールを守るのは面倒…。
GUIのツールはいくつかありましたが、自前で改造やすいように作ってみました。

「Conventional Commits Form」とは？

「Conventional Commits Form」は、HTMLだけで動作するシンプルな入力フォームです。
ブラウザ上で必要な情報を入力するだけで、Conventional Commits 形式のコミットメッセージを自動生成してくれます。

主な機能

• type、scope、description など、規約に沿った項目の入力欄を用意
• 入力内容をリアルタイムでフォーマットし、下部に表示
• そのまま git commit -m に貼り付けられるテキストを生成
• ローカルで動作。インストール不要・ネットワーク接続不要

使い方

1. GitHub から ConventionalCommitsForm.html をダウンロード
2. ダブルクリックで開く（ブラウザが起動）
3. 入力欄に必要な情報を入力
4. 表示されたコミットメッセージをコピー
5. GIT(GUI)のコミット時のコメント欄に貼り付けて完了！

出力されるメッセージの例

feat(login): ログイン時のバリデーションを追加

ユーザーが空のメールアドレスで送信しようとした場合に警告を表示するようにしました。

BREAKING CHANGE: バリデーションの失敗時、APIリクエストを送らなくなりました。

おわりに

統一された書式は、自動化の第一歩です。
例えば、バージョンアップリリース時の変更一覧の作成時も機械的に一次処理が行えます。
無駄な作業を減らすためにも、検討してみては如何でしょうか。