保守性の高いコミットメッセージを書こう

3058 ワード
commit GitHub log Git Git テキストリンク

はじめに

みなさんこんにちは。突然ですが、コミットメッセージを適当な気持ちで書いていませんか？
2,3週間後に過去のコミットのログを見直したときに、何についての変更なのかがわかりづらくて昔の自分を殴りたくなった経験はありませんか？

そんなあなたにとっておきのプラグインを紹介いたします。

概要

結論から申し上げますと、commitizenを使うだけです。

Commitizenとは?
CLIを使って対話的にコミットメッセージを作ることができるコマンドラインツールです。

導入手順

以下の記事を参考に導入して参ります。

Commitizenを使ってもうコミットメッセージに迷わない
個人開発者のためのコマンドラインGit使いこなし術


①グローバルにインストール
(ローカルにインストールすることもできますが、今回はグローバルにインストールします。)
以下のコマンド

$ npm install commitizen -g
$ npm install -g cz-conventional-changelog

②グローバルのルート直下に.czrcファイルを作成

$ touch .czrc
$ vim .czrc
.czrc
{ "path": "cz-conventional-changelog" }

以上です。gitでaddした後に
$ git cz
を入力するとcommitizenがスタートし、以下のような対話形式でメッセージを入力する流れとなります。

コミット後に
$ git log --graph
を入力すると以下のようにメッセージを含んだlogが表示されます。

参考記事

非常にわかりやすかったです。ありがとうございました。

【今日からできる】コミットメッセージに 「プレフィックス」 をつけるだけで、開発効率が上がった話
僕が考える最強のコミットメッセージの書き方



[Question] SyntaxError: Parsing JSON at <path> for commitizen config failed:に対するエラーは以下のissueで議論されていました。
[Question] SyntaxError: Parsing JSON at for commitizen config failed: