Skip to content

ブランチ命名規則 #7

@nkoji21

Description

@nkoji21

基本ルール

チケット番号がある場合は、
type/issue-number/description の形式を使用してください。

type/issue-number/short-description

example:
feature/42/add-quiz-problems
  • type: ブランチの目的を表す種別です。(詳細は後述)
  • issue-number (任意): 関連するチケット番号や課題番号です。
  • description: ブランチの作業内容を簡潔に英単語で表現します。

命名ルール詳細

  • 全て英数字の小文字を使用
  • 単語の区切りには - を使用 (例: add-login-form) ケバブケース
  • 説明 (description):
    • 動詞から始めることを推奨 (例: add-, update-, remove-)
    • 具体的でわかりやすい単語 (ブランチ名から作業内容を予測できるように

ブランチ種別

作成時、その目的に応じて以下の type のいずれかを接頭辞として使用

type 説明
feature ユーザー向けの新機能の実装
fix バグの修正
hotfix 本番環境で発生した緊急性の高いバグの修正
refactor 機能追加やバグ修正を含まない、コードのリファクタリング
docs READMEやドキュメントの作成・更新
chore ビルドツールや設定ファイルの変更など、ソースコードの変更を含まない雑多なタスク
test テストコードの追加・修正

Metadata

Metadata

Assignees

No one assigned

    Labels

    📝 ドキュメントREADMEや説明書などの文章作成・修正タスク

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions