『コミットメッセージに「プレフィックス」をつける』を検討した

Qiita でコミットメッセージに「プレフィックス」をつけるというアイディアが紹介されていて、その効用の一つとして挙げられている:

プレフィックスを意識しながら順序立てて機能を作成する癖が身につく

という点が、試験運用していて実際に魅力的だと感じた。

しかし GitHub のコロン記法 (:sparkles: みたいなの) はターミナル上では絵文字として表示されないし、そもそも特定のサービスに不必要に依存したくない。では utf-8 の絵文字そのものではどうかというと、フォントによっては表示されなかったり、 utf-8 に依存するのが気になる。ターミナル上では色がつかない (※フォントによる) ので視認性もいまいちだ。

入力が面倒だという問題は、コミットフックでコロン記法 (:sparkles: みたいなの) から絵文字に自動で変換するという案もある (※試していない)。

また、単純に ASCII 文字を使うという手もある。 + Add new feature とか - Remove a file みたいな感じだ。 + と - ぐらいならいいが、それ以外はかなり涙ぐましい状態になる。

以下の観点について比較してみよう。

楽さ。プレフィックスをつけてコミットメッセージを書くのに手間がかからないほうがよい。
明確さ。表記と意味の関係が自然であるほど覚えやすく、曖昧性が低い。初めて見た人にでも意味が分かるとなおよい。
視認性。プレフィックスの意味を把握している人にとって、パット見て分かりやすいか。
依存関係。寿命のなさそうな技術に依存するのはマイナス。

種類	楽さ	明確さ	視認性	依存関係
英語	○	○	△	○
絵文字	×	△	○	△
コロン記法	△	△	○	×
ASCII	○	×	△	○

依存関係の評価に関して念のためにいうと、 GitHub や utf-8 に限界を感じているわけではなくて、10年後ぐらいにひょっこり消えてる可能性がないこともないぐらいの意味。

そういうわけで feat: とかを使っていくことにする。

『コミットメッセージに「プレフィックス」をつける』を検討した

関連リンク

関連記事