Conventional Commitsとは何かを解説

Conventional Commitsとは何かについて解説します。

Conventional Commitsとは

コミットメッセージの軽量規約

コミットメッセージを読みやすくするための仕様で、細かくルールが定められています。

例えば下記のようなルールが定められています。

具体的な例

具体的なコミットメッセージを用いて解説します。

feat: ユーザーフォロー機能の追加

タイムラインのフォロー機能とは異なるユーザーのフォロー機能を追加。

タイムラインとは別のロジックのため別のファイルに分けている。

See-also: https://hogehoge.com/abc
Ref: #abc

Prefixとタイトル

feat: ユーザーフォロー機能の追加

Prefixとタイトルに関する主なルール(一部)はこちらです。

本文

タイムラインのフォロー機能とは異なるユーザーのフォロー機能を追加。

タイムラインとは別のロジックのため別のファイルに分けている。

本文に関する主なルール(一部)はこちらです。

フッター

See-also: https://hogehoge.com/abc
Ref: #abc

フッターに関する主なルール(一部)はこちらです。

Conventional Commitsのメリット

Conventional Commitsのメリットについて解説していきます。

開発者側がコミットを理解しやすい

そもそもコミットメッセージは、変更点を伝えるためにあるので、ルールを用いて標準化することは大きなメリットです。

ルールがなければ、メッセージから変更点がわかりやすい人がいたり雑でわかりにくい人がいたりとなかなか大変になります。

フォーマットが統一されていることでPRのレビューであったり、過去の変更点を確認する際に理解の助けになります。

実際に個人やチームで導入する際には、commitlintなどを使うとルールの適用をシステム的に行うことができるのでおすすめです。

システムが理解しやすい

フォーマットが統一化されていることでシステムも理解しやすいです。

つまり、コミットメッセージを用いた自動化ができます。

例えば、main(master)ブランチにマージしたときに、自動でCHANGELOGを作成したりすることが容易になります。

よく使われるPrefix一覧

Conventional Commitsでは、featやfix以外も使うことができます。

よく使われるPrefix一覧を紹介します。

まとめ

Conventional Commitsとは何かについて解説しました。