commit messageルール
何が変更されたのか、なぜ変更されたのか、どのように変更されたのかを簡潔に説明する
1つの意味のあるまとまりでコミットを作成する
テンプレート
[タイプ] 概要 (#issue番号)
詳細な説明(option)
- タイプをPrefixでつける
feature
: 新しい機能の追加bugfix
: 既存の機能の不具合やエラー修正hotfix
: 本番環境での緊急性の高いエラー修正docs
: ドキュメント、README、コメント、ウェブサイトの文面や画像の変更style
: コードの書式設定(インデント、空白など)や構文上の修正refactor
: 仕様に影響がないコード改善(リファクタリング)perf
: 主にパフォーマンス向上を目的とした修正test
: テスト関連chore
: ビルド設定、依存関係の更新、ツール設定など、直接機能に影響しないメンテナンス作業
- タイプが複数にまたがる場合は
/
区切りで複数入れる
使用例
[feature] 〇〇の追加 (#1)
[fix] 〇〇なため、△△を修正 (#13)
レスポンスデータの内部構造が期待値と異なったため、仕様通り修正