inkblot-branch-naming について
inkblot-branch-namingは、Jiraチケットに関連する作業のGitブランチ命名規則を定めるスキルです。完全な小文字のチケットキーを先頭に置き、短いkebab-caseの説明を続けます。チケットがない作業には命名制限がありません。
主な機能
- 01完全な小文字のJiraキーを先頭に配置
- 02短いkebab-caseの変更説明を使用
- 03種別プレフィックスと複数キーを避ける
- 04チケットなしのブランチ名は自由
活用シーン
- 01Jiraチケットに関連する変更のブランチ命名
- 02GitHubの一覧でブランチを見分けやすくする
- 03無効なキーや短縮キーの使用を防止
- 04チケットのない雑務やホットフィックスの自由な命名
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ inkblot-therapy/ ai-skills --skill inkblot-branch-namingインストール後、Claude Code で/inkblot-branch-namingを入力して読み込まれたか確認します。
詳細
Inkblot のブランチ命名規則
この規則が必須となるのは、作業に Jira チケットがある場合のみです。チケットがない場合は、プレフィックスを勝手に付けたり、チケットを求めたり、名前を制限したりしないでください。
チケットがある作業(必須)
ブランチ名は、Jira の完全なキーを小文字にして先頭に付けます。feat/、fix/、feature/ のようなプレフィックスは付けないでください。
<ticket-id>-<short-kebab>
- 完全なキーを小文字にし、主チケットは1つにします(例:
pod2-2291。2-2291ではありません) - kebab-case は小文字で、3~5語にします。チケットのタイトルではなく、変更内容を表してください
- GitHub のブランチ一覧で読みやすいよう、名前全体を短く保ちます(約50文字)
例
pod2-2291-video-call-no-showpod1-3452-company-renewal-datespod1-3459-coaching-duration-options
禁止事項(チケットがある作業のみ)
- チケット ID の前にプレフィックスを付けないでください(
fix/pod2-2291-…、feat/…、feature/…、bf-…) - プロジェクトキーを短縮しないでください(
2-2291-…、1-3452-…) - ブランチ名に大文字を使わないでください(
POD2-2291-…) - 名前にイニシャルを入れないでください(
ji-pod1-2178-…) - 対象環境を末尾に付けないでください(
-qa、-master) - チケット ID を並べないでください(
pod2-2276-2277-2282-…)。主チケットを使用してください - Jira のタイトル全体を kebab-case にして入れないでください
チケットがない場合
命名規則はありません。hotfix/7.54.2、sync/…、qa-kuma など、どのような名前でも問題ありません。
理由
- チケットを先頭にし、種別プレフィックスを付けない: Jira と
git grepでは、キーが先頭にある必要があります。feat/やfix/を付けても長くなるだけです。 - 完全なキーを小文字にする:
pod2-2291も Jira のキーです(リンクは機能します)。小文字にすることで、macOS と Linux の大文字・小文字の区別による問題を避けられます。2-2291は Jira のキーではないため、GitHub と Jira はブランチを関連付けません。 - チケットがある場合にのみ適用: チケットのない雑務、同期、ホットフィックスを、エージェントによって阻止されたり、名前を変更されたりしないようにします。
- 短い kebab-case: GitHub では長いブランチ名が省略されます。チケットのタイトルはすでに Jira にあります。
コメント
Markdown 対応