ITエンジニア/デザイナ向けにオープンソースを毎日紹介

バージョン管理でコミットメッセージを書くときについつい一行で適当に書いてしまわないでしょうか(筆者はそうなのですが…)。これは本来よくありません。特にオープンソースのように第三者が見る場合にコミット内容が分かりづらいのは問題です。

そんな分かりづらいコミットメッセージを書いてしまう方に使ってみて欲しいのがfit-commitです。

fit-commitの使い方

fit-commitのインストールはRubygemsで行います。そして任意のGitリポジトリでinstallサブコマンドを実行します。

$ fit-commit install
Installed hook to .git/hooks/commit-msg

これで準備は完了です。適当なコミットメッセージを書いてみましょう。

$ git commit 
test

1: Error: Begin all subject lines with a capital letter.

このようにサブジェクトは大文字ではじめましょう、と出ました。さらにメッセージを変えてみます。

$ git commit 
Test test test test test test test test test test test.
日本語で記述します。日本語でコミットメッセージを書きます。これくらい長いとエラーになります。

1: Error: Do not end your subject line with a period.
1: Warning: Subject line should be <= 50 chars. (55)
2: Error: Second line must be blank.

エラーもありますが、ウォーニングもあります。2行目は空欄にするのは大事ですね。fit-commitを使えば一定の基準に沿ったコミットメッセージが書けるようになります。こういった工夫が健全なGitリポジトリの運営につながるのではないでしょうか。

fit-commitはRuby製、MIT Licenseのオープンソース・ソフトウェアです。

m1foley/fit-commit

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2