fix: バグの修正
バグ修正のための適切なfixコミットメッセージの書き方を学びます。フォーマットルール、良い説明と悪い説明の例、イシュートラッカーへの参照方法を含みます。
Type Examples
詳細な説明
fix コミットタイプ
fixタイプは、コードベースのバグを修正するコミットに使用します。Semantic Versioningでは、fixコミットはpatchバージョンバンプ(例:1.2.1から1.2.2)をトリガーし、新機能の導入や破壊的変更なしに既存の機能が修正されたことを示します。
メッセージの例
fix: prevent crash when user profile is null
fixを使うタイミング
以下の場合にfixを使用します:
- 不正な動作や出力を修正する
- クラッシュ、例外、エラーを解決する
- 以前のコミットで導入されたリグレッションを修正する
- セキュリティ脆弱性にパッチを当てる
- データ処理やバリデーションの問題を修正する
イシューの参照
フッターでイシューやバグチケットを参照するのが良い慣習です:
fix: prevent crash when user profile is null
Check for null profile before accessing display name.
Previously, new users without a completed profile would
cause a TypeError on the dashboard page.
Closes #542
Closes #542フッターはGitHub(および類似プラットフォーム)に、このコミットがマージされたときにissue #542を自動的に閉じるよう指示します。他の一般的なキーワードにはFixes、Resolves、Refsがあります。
よくある間違い
| 悪い例 | 理由 | 良い例 |
|---|---|---|
fix: fixed the bug |
過去形、曖昧 | fix: prevent null pointer on dashboard |
fix: Bug fix. |
ピリオド、曖昧 | fix: resolve incorrect date parsing |
fix: Fix issue #123 |
大文字、チケットの繰り返し | fix: handle empty response from API |
fixとrefactorの選択
バグを修正するコードの再構築はfixを使います。タイプは技術ではなく影響を記述します。動作が変わらない場合のみrefactorを使います。
ユースケース
ユーザーがプロフィール設定を完了せずに設定ページにアクセスしようとするとアプリケーションがクラッシュするという報告がありました。null参照エラーを特定しガードチェックを追加しました。修正を伝え、バグレポートにリンクするコミットメッセージが必要です。