ツール説明

Branch Name Generatorは、Git branch nameのベストプラクティスに従って適切にフォーマットされたGitブランチ名を作成するのに役立つ開発者向けツールです。JIRAチケットまたは単純なテキスト説明を使用している場合でも、このGitブランチ作成ツールは自動的にチケットIDを抽出し、テキストをクリーンアップし、一般的なGitブランチング規約に従ってすべてをフォーマットします。Gitブランチに一貫性のある名前を付ける方法について疑問に思ったことがあれば、このツールはチーム全体が標準化されたブランチ命名パターンに従うことを保証します。

機能

  • JIRAチケット抽出: 入力からJIRAチケットID（例：PROJ-123）を自動的に検出して抽出します
  • ブランチタイププレフィックス: 一般的なブランチタイプ（feature、bugfix、hotfix、release、chore、refactor、docs、test、またはプレフィックスなし）から選択します
  • カスタマイズ可能な区切り文字: ハイフン、アンダースコア、またはその他の文字を単語区切り文字として使用します

ブランチタイプ

  • feature: 新機能と機能用
  • bugfix: 通常のバグ修正用
  • hotfix: 緊急の本番環境修正用
  • release: リリース準備ブランチ用
  • chore: メンテナンスタスクと更新用
  • refactor: コードリファクタリング用
  • docs: ドキュメント更新用
  • test: テスト関連の変更用
  • none: タイププレフィックスなしでブランチ名を生成します

Gitブランチ命名のベストプラクティス

Gitブランチに名前を付ける方法を理解することは、クリーンなリポジトリを維持するために重要です。生成されたブランチ名は、業界標準のGitブランチ命名ベストプラクティスに基づいて、この構造に従います：

[branch-type]/[TICKET-ID]/[description-with-separators]

適切にフォーマットされたGitブランチ名の例：

  • 入力: PROJ-123 Add user authentication 出力: feature/PROJ-123/add-user-authentication

  • 入力: Fix login error 出力: bugfix/fix-login-error

  • 入力: Update documentation for API 出力: docs/update-documentation-for-api