コンベンショナルコミットとは？: ガイドラインと実例
目次
1. はじめに
コンベンショナルコミットとは、コミットメッセージに一定のフォーマットや規則を持たせるスタイルガイドです。これにより、プロジェクトの履歴を明瞭に保ち、他のメンバーとのコミュニケーションを円滑にします。
2. なぜコンベンショナルコミットか？
コンベンショナルコミットを採用する主な利点は、コミット履歴が標準化されるため、履歴を追いやすくなる点です。さらに、この規則に従うことで自動的にChangelogを生成することも可能です。
3. コミットタイプ
コンベンショナルコミットにはいくつかの基本的なコミットタイプがあります。
- feat: 新機能
- fix: バグ修正
- chore: その他の変更（ビルドスクリプト、ドキュメント生成など）
- docs: ドキュメントのみの変更
- style: コードの意味に影響を与えない外観の変更（スペース、フォーマット、セミコロンの欠落など）
- refactor: バグを修正するものでも新機能を追加するものでもないコード変更
- perf: パフォーマンスを向上させるコード変更
- test: 既存のテストの修正または新しいテストの追加
4. 実例
以下はいくつかの実例です。
# 新機能を追加
git commit -m "feat: add login function"
# バグを修正
git commit -m "fix: resolve issue with API endpoint"
# ドキュメントを更新
git commit -m "docs: update README"
5. さらに詳しく
コンベンショナルコミットの詳細なガイドラインについては、公式のConventional Commitsウェブサイトを参照してください。
ここでは詳しくは触れませんが、コンベンショナルコミットを活用することで、Changelog の自動生成、セマンティックバージョニングにもつながります。これらについては記事を分けて説明しようと思います