commit時の接頭辞について - mrstsgk/daycare-app-portfolio GitHub Wiki

Welcome to the daycare-app-portfolio wiki!

コミットメッセージ規約

本プロジェクトではConventional Commits形式に従ったコミットメッセージを使用しています。以下の接頭辞を使い分けてください：

接頭辞	説明	使用例
feat:	新機能の追加	feat: 生徒検索機能を追加
fix:	既存コードのバグ修正（動作の誤りを正す）	fix: 生徒一覧が正しく表示されない問題を修正
docs:	ドキュメントの変更のみ	docs: READMEにデプロイ手順を追加
style:	コードの意味に影響しない変更（フォーマット等）	style: インデントの修正
refactor:	機能追加やバグ修正を伴わない、コードの整理や構造改善	refactor: 生徒データ取得処理の重複コードを共通化
perf:	パフォーマンス改善のためのコード変更	perf: データ取得のクエリを最適化
test:	テストの追加や修正	test: 生徒登録機能のテストを追加
chore:	ビルドプロセスや補助ツールの変更	chore: パッケージの更新

fix: vs refactor: の違い

• fix: - 正しく動作していなかった機能を修正する場合に使用します。例えば、データが表示されない、計算結果が間違っている、特定の条件でクラッシュするといった問題の修正がこれに当たります。

  • 例: fix: 登録フォームでエラー時にメッセージが表示されない問題を修正

• refactor: - 外部から見た機能は変わらないが、内部のコード構造を改善する場合に使用します。コードの可読性向上、保守性向上、重複コードの排除などがこれに当たります。

  • 例: refactor: 認証処理を個別のサービスクラスに分離

例えば、同じコードの変更でも：

• 「APIが間違ったデータを返していた」問題を直す → fix:
• 「動作は正しいが、コードが複雑で理解しにくい」状態を改善 → refactor: