【Prefixとは？】Gitのcommit時に使いたい単語一覧を紹介

以前、Gitのコミットについて紹介する記事を書きました。

コミットはコードの変更履歴をメッセージと共に記録します。

そのコミット履歴を見た時に、コミットメッセージが全て同じ（例えば update）だったらどう思いますか？

各コミットをクリックしないと変更内容がわからず、後から確認するにはすごい手間ですよね。

そこで今回は、Gitでコミットする際に便利な「prefix（プレフィックス）」を紹介します。

ステップは以下の通りです。

最後までご覧いただき、参考にしていただけると幸いです。

コミットメッセージは重要

コミットメッセージはわかりやすいものにしましょう。

パッと見た時に、なんとなくでも「これを変更したんだな」と思えるようなメッセージにしなければなりません。

特に共同開発では重要です。例えば過去のコミットで不具合が出てしまった場合に、不具合の元となったコミットを取り消せば済む話ですが、コミット名が全て同じ（例えば update）だった場合、1つずつ探さなければ見つけることができません。非常に大変です。

プレフィックスとは？

プレフィックスとは、コミットメッセージの先頭に付ける短い識別子のことです。

この識別子を使うことで、コミットの内容が一目で分かりやすくなります。例えば、バグ修正、機能追加、ドキュメント変更などの種類ごとに異なるプレフィックスを付けると便利です。

例えば、スライダー機能を追加したことを示すコミットメッセージは以下のようになります。

feat: Slider

featは新機能の追加を意味するので、このメッセージはスライダー機能を追加したことを意味します。

プレフィックスを使用することで、コミットメッセージが整理され、履歴を遡る際にも目的のコミットを簡単に見つけることができます。共同開発でも個人開発でも、この方法は非常に有効です。

プレフィックスの例

それでは筆者が普段使用するプレフィックスの例をいくつか紹介します。

項目は以下の通りです。

それぞれ解説します。

feat

これは前述しましたが、新機能を追加した際に使用します。

以下に例を示します。

feat: TableOfContent

上記は目次機能を追加したという意味になります。

fix

これは、バグや不具合を修正した際に使用する識別子です。

以下に例を示します。

fix: TableOfContent

上記は「目次の不具合を修正した」という意味になります。上記に続けて不具合名を入れると、さらにわかりやすくなります。

add

この識別子は、新しいファイルや機能を追加した際に使用します。

記述方法は以下の通りです。

add: ProfilePage

上記は「プロフィールページを追加した」という意味になります。

remove

この識別子は、ファイルや機能を削除する際に使います。

記述方法は以下の通りです。

remove: TableOfContent

上記は「目次機能を削除」という意味になります。

chore

この識別子は、コードの変更でありながら、機能追加やバグ修正とは直接関係のないメンテナンス作業や補助的な変更に使用します。

例えば、「依存関係の更新」、「ビルドスクリプトの変更」などが該当します。

記述方法は以下の通りです。

chore: npm update

あくまでも例ではありますが、上記はnpm updateをした際の依存関係の更新をchoreで伝えています。

Refactor

この識別子は、既存のコードの内部構造を改善するための変更を示します。機能的な変更は含まれず、コードの可読性や保守性の向上を目的としています。

記述方法は以下の通りです。

refactor: ProfilePage

上記のコードは、「プロフィールページ」をリファクタリングしたという意味になります。

最後に

ここまで、Gitをコミットする際につけたいプレフィックスについて紹介しました。

筆者も最初は「update」など適当な名前をつけてコミットしていましたが、Gitを理解してくるうちにかなり不便であることに気づきました。

プレフィックスを知ってからメンテナンスが簡単になり開発効率も上昇しました。

ぜひ、プレフィックスを使って個人開発や共同開発を行なってみてください。

ここまでお読みいただき、ありがとうございました。