LoginSignup
3
1

More than 3 years have passed since last update.

Commitizenを使用してコミットメッセージを統一する

Last updated at Posted at 2021-01-30

はじめに

  • コミットメッセージの入力で迷うことが多々ある
  • コミットメッセージが統一されていない(個人/チーム関わらず)

以上のような悩みがあり、今回Commitizenを導入しました。

Commitizenとは

公式ページ
https://github.com/commitizen/cz-cli

'git cz' とタイプするだけで選択肢が表示され、対話形式で質問に答えていくだけでシンプルでわかりやすいコミットメッセージを作成することができるというツールです。
スクリーンショット 2021-01-30 15.39.55.png

導入方法と使い方

インストール

下記コマンドでグローバルインストールしました。

npm install commitizen -g
npm install -g cz-conventional-changelog
echo '{ "path": "cz-conventional-changelog" }' >> ~/.czrc
exec $SHELL -l

使い方

'git cz'コマンドで起動します。

git cz

スクリーンショット 2021-01-30 15.39.55.png

今回はREADME.mdを追加しただけなので、docsを選択します。
スクリーンショット 2021-01-30 15.40.08.png

変更のスコープを聞かれるので、README.mdと入力します。
スクリーンショット 2021-01-30 15.40.24.png

次に短い説明文を入力します。今回はadd READMEとしました。
スクリーンショット 2021-01-30 15.40.38.png

次に長い説明文を入力します。今回は詳しい説明は不要なのでEnterでスキップしました。
スクリーンショット 2021-01-30 15.40.51.png

破壊的な変更はあるか聞かれますが、今回はNoです。
スクリーンショット 2021-01-30 15.41.02.png

issueと関係しているか聞かれますが、こちらもNoです。
スクリーンショット 2021-01-30 15.41.13.png

以上で終わりです。どのようなコミットメッセージが作成されたか確認してみると以下のようになっています。

docs(readme.md): add README

スクリーンショット 2021-01-30 15.41.39.png

最後に

以上、Commitizenの導入方法と使い方でした。見ていただきありがとうございました。

3
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
1