Primary About Development

Gitコミットログにステータスを追加してわかりやすくする方法

2023-07-26

Gitを活用する際、特にチームでの開発でコミットログが増えると、どのコミットがどのような変更を伴うのかを一目で理解するのは難しくなります。そのような時に役立つのが、コミットメッセージのプレフィックスとしてステータスを追加する方法です。

コミットの種類とプレフィックス

以下に、代表的なコミットの種類とそれを示すプレフィックスを示します:

  1. feat: - 新しい機能の追加
  2. fix: - バグの修正
  3. docs: - ドキュメンテーションの変更
  4. style: - スタイルやコードの書式に関する変更(機能やロジックに変更を加えないもの)
  5. refactor: - コードのリファクタリング
  6. perf: - パフォーマンスの改善
  7. test: - テストの追加や修正
  8. chore: - ビルドプロセスや補助ツール、ライブラリなどの変更

実際のコミットメッセージ例

feat: ユーザープロフィールページを追加
fix: ログイン時のバグを修正
docs: APIの使用方法を記述
style: インデントを修正
refactor: ユーザーコントローラーを整理

なぜこの方法が便利なのか?

  • 一目で変更内容が理解できる:上記のようにプレフィックスをつけることで、何の変更が行われたのかがすぐにわかります。
  • フィルタリングや検索が容易:特定の種類のコミットだけを見たい場合や、検索を行いたい場合にも、プレフィックスを利用することで簡単に対象のコミットを絞り込むことができます。

Gitをより効果的に利用するためには、このような小さな工夫も大切です。チームのメンバーと共有し、統一したコミットルールを確立することで、開発の効率も向上します。

プロフィール写真

Soraef

ソフトウェアエンジニア。趣味は競馬、写真、ゲーム。

お問い合わせはTwitterのDMでお願いします。