MyCanvas

コミットメッセージのプレフィックスに関して

はじめに

みなさまは普段Gitを使用していますでしょうか? 使用していれば少なからずコミットする機会はあると思います。 今回はそんなコミットに添えるメッセージに関してお話させていただければと思います。

プレフィックスを気にする理由

これはコミットが機能に与えた影響を一目でわかるようにするためです。 コミットメッセージの文字数には限りもあるため、プレフィックスでコミットの属性がわかるようにするのはとても重要だと考えております。

プレフィックス一覧

私が使用しているプレフィックス一覧は以下です。

プレフィックス説明
[feat]新たな機能を追加した際に付与するプレフィックス
[impr]既存機能をエンハンスやリファクタリングをした際に付与するプレフィックス
[fix]バグを修正した際に付与するプレフィックス
[del]不要な要素を削除した際に付与するプレフィックス

4つと少ないですが、今のところコミットメッセージ記述時に困ることはありません。 あとは少ないとより管理がシンプルになるので、不用意に増やさないようにしております。

さいごに

コミットにプレフィックスを付与することでコミットメッセージの属性が明確になります。チームでルールを作って運用できると生産性向上に繋がるのではないかと思います。 その際に私のプレフィックスルールが参考になれば幸いです。 今回は以上となります。 別の記事も執筆しておりますので、みていただけると嬉しいです。 よろしくお願いいたします。

© 2023 maruyakiプライバシーポリシー