bugfixブランチの命名規約
バグチケットを参照し修正内容を説明する明確なbugfixブランチ名を作成し、チームが開発パイプラインを通じてバグ解決を追跡できるようにします。
Branch Types
詳細な説明
bugfixブランチの命名
bugfixブランチは、開発中やQAテスト中に発見された既知の欠陥に対処します。hotfixブランチとは異なり、緊急の本番環境の問題ではなく、次のリリースサイクルで予定される修正です。
標準フォーマット
bugfix/{ticket}-{description}
例
| バグチケット | 説明 | ブランチ名 |
|---|---|---|
| BUG-456 | ログインリダイレクトループの修正 | bugfix/bug-456-fix-login-redirect-loop |
| #1023 | タイムゾーンオフセットの修正 | bugfix/1023-correct-timezone-offset |
| ISSUE-78 | キャッシュのメモリリーク解消 | bugfix/issue-78-resolve-memory-leak-in-cache |
BugfixとHotfixの違い
ワークフローの一貫性のために、この区別を理解することが重要です:
| 項目 | Bugfix | Hotfix |
|---|---|---|
| 緊急度 | 予定済み、非クリティカル | 緊急、本番影響あり |
| 分岐元 | developまたはmain |
mainまたはproduction |
| マージ先 | develop → main |
mainに直接、その後バックマージ |
| レビュー | 標準的なPRレビュー | 迅速なレビュー |
Bugfixの命名ベストプラクティス
修正の性質を示すアクション動詞で説明を始めます:fix-、resolve-、correct-、patch-、repair-。これにより、ブランチ名が自己文書化されます。例えば、bugfix/BUG-456-fix-null-pointer-on-loginは、チケットを確認しなくてもブランチが何に対処しているかをチームメンバーに即座に伝えます。
バグが特定のコンポーネントに影響する場合は、名前に含めます:bugfix/BUG-789-fix-sidebar-overflow-on-mobile。これは複数のバグが同時に修正されている場合に、レビュアーが各変更のスコープを理解するのに役立ちます。
ユースケース
QAエンジニアがセッション期限切れ時にログインページが無限リダイレクトループに入るバグレポートを提出しました。開発者はこれがバグ修正であることを明確に示し、チケットを参照し、問題を説明するブランチ名が必要です。