📝 Gitコミットメッセージガイドライン
目次
はじめに
このガイドラインは、チーム開発における効果的なGitコミットメッセージの作成方法をまとめたものです。 適切なコミットメッセージは、コードレビューの効率化やプロジェクトの履歴管理に重要な役割を果たします。
基本ルール
- 先頭にカラフルでユニークな絵文字を付与し、可読性を向上させる
- 日本語でコミットメッセージを作成する
- 変更内容が分かるように、タイトルと概要を記載する
- 必要であればブランチを作成して提案する
コミットメッセージの形式
<絵文字> <タイプ>: <タイトル>
<本文>
<フッター>
コミットメッセージのタイプ
feat: 新機能fix: バグ修正docs: ドキュメントの変更style: コードスタイルの変更refactor: リファクタリングperf: パフォーマンス改善test: テストの追加・修正chore: ビルドプロセスやツールの変更
Gitflow概念に基づくブランチ戦略
main: 製品リリース用のブランチdevelop: 開発用のブランチfeature/*: 新機能開発用のブランチrelease/*: リリース準備用のブランチhotfix/*: 緊急バグ修正用のブランチ
その他のガイドライン
- 主要な変更とその目的に焦点を当てる
- 変更を明確かつ簡潔に説明する
- 見やすさを重視し、必要に応じて箇条書きを使用する
- 同じ絵文字の多用を避ける
詳細な使用例や実践的なパターンについては、コミットメッセージ例を参照してください。