Gitブランチ名とコミットルールについて

Gitブランチ名とコミットルールについて

技術公開日 読了目安 1 分

個人的なGitブランチ名とコミットメッセージのルールです。

ブランチ名

個人開発

+-- main
|   +-- feature/{機能名}
|   +-- hotfix/{バグ識別名}
  • 基本はmainとfeatureのみ利用する。

チーム開発(小規模)

+-- main
|   +-- develop
|   |   +-- feature/{派生元バージョン番号}-{機能名}
|   |   +-- release/{バージョン番号}
+-- hotfix/{バージョン番号}-{バグ識別名}

※モノレポでアプリ毎にブランチを管理する場合

develop-{システム名}
feature-{システム名}/{派生元バージョン番号}-{機能名}
etc.

コミットメッセージ

プレフィックス 説明
feat: 新機能
fix: バグの修正
docs: ドキュメントのみの変更
style: コードの動作に影響しない、見た目だけの変更(スペース、フォーマット、欠落の修正、セミコロンなど)
refactor: バグの修正や機能の追加ではないコードの変更
perf: パフォーマンスを向上させるコードの変更
test: 不足しているテストの追加や既存のテストの修正
chore: ビルドプロセスやドキュメント生成などの補助ツールやライブラリの変更

※モノレポの場合、プレフィックスの後にシステム名を付ける。

feat({システム名})
e.g. feat(web)

一行目にプレフィックス付きのタイトルを、
二行目は改行のみ、
三行目に変更の目的と内容を具体的に記載する。

feat:ユーザのログイン機能追加

ユーザのログイン機能、ユーザ認証の機能を追加しました。