はじめに
gitのコミットメッセージを記述する際、統一できず、書き方を迷うことがあったため、
Commitizenで統一する方法についてご説明致します。
到達点
以下の2点を達成する
・Commitizenのインストール方法を学ぶ
・コミットメッセージを統一する
流れ
① Commitizenのインストール方法
② コミットメッセージの記述方法
① Commitizenのインストール方法
$ npm install -g commitizen
$ touch .czrc
$ vim .czrc
コマンドを入力するだけでインストールできます。
そして日本語訳にするため、ファイルを作成し以下の通りに修正します。
/.czrc
{
"path": "cz-conventional-changelog-ja"
}
.czrcに入力するだけで、日本語訳に変換されます
② コミットメッセージの記述方法
$ git add .
$ git cz
1行目は100文字で切り取られ、超過分は次行以降に記載されます。
? コミットする変更タイプを選択:
fix: バグ修正
docs: ドキュメントのみの変更
style: フォーマットの変更（コードの動作に影響しないスペース、フォーマット、セミコロンなど）
refactor: リファクタリングのための変更（機能追加やバグ修正を含まない）
perf: パフォーマンスの改善のための変更
test: 不足テストの追加や既存テストの修正
build: ビルドシステムや外部依存に関する変更（スコープ例: gulp, broccoli, npm）
ci: CI用の設定やスクリプトに関する変更（スコープ例: Travis, Circle, BrowserStack, SauceLabs)
chore: その他の変更（ソースやテストの変更を含まない）
revert: 以前のコミットに復帰
feat: 新機能
(Move up and down to reveal more choices)
git czとコマンドを打つと、11のタイプに分かれているので、適したタイプを選択します。
以下の順番で入力していきます。
・コミットのタイプ(prefix)
・コミットのスコープ
・コミットのタイトル
・コミットの本文
・破壊的変更の有無
・関連issueの有無
コミットタイプとコミットタイトルのみ記入必須です！
$ git log
* commit f5f8e64d520e33ba2497b08aefa52c756c45629f
| Author: #省略
| Date: #省略
| perf: N+1対策修正 #23
:
git logで確認すると、コミットされたことが確認できます。