コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

ブランチ戦略

ブランチ構成、運用フロー、命名規則、保護ルールの設定

ブランチ構成

Git のブランチは次の 2 つを基本として維持します。

  • main: 本番環境と常に同じ状態を保持するブランチ
  • develop: 開発とステージング環境用のブランチ。GitHub のデフォルトブランチにする

develop をデフォルトブランチにすると、PR の向き先が自動で develop になり、main へ誤ってマージする事故を防げます。

運用フロー

主な開発フローは次のとおりです。

  1. develop からトピックブランチ(例: feature/xxx、fix/yyy)を作成する。
  2. ローカルで作業し、必要なコミットを行う。
  3. トピックブランチを PR で develop へマージしてステージング環境で動作確認を行う。
  4. テストやステージングでの確認が完了したら、リリース準備を進める。
  5. リリース時に develop から main への PR を作成してマージし、本番へデプロイする。

リリースの手順とタグの付け方はリリースとロールバックを参照してください。

緊急修正(hotfix)

本番環境の不具合を develop の開発中の変更を含めずに直す場合は、main から修正します。

  1. main から hotfix/<対応内容> を作成する。
  2. 修正して PR で main へマージし、本番へデプロイする。
  3. main から develop への PR を作成し、merge commit でマージして修正を develop にも取り込む。

ブランチの命名規則

ブランチ名は、他の人が見て内容や目的が分かることを最優先にします。

命名パターン

  • 機能追加: feature/<機能名>
  • バグ修正: fix/<修正内容>
  • 緊急対応: hotfix/<対応内容>
  • リファクタリング: refactor/<対象>
  • ドキュメント: docs/<内容>

課題がある場合は、Backlog の課題キーや GitHub の Issue 番号を含めても構いません(例: feature/PROJ-123-login-form、fix/45-header-overlap)。

命名例

feature/user-authentication
fix/login-validation-error
hotfix/payment-gateway-timeout
refactor/api-error-handling
docs/setup-guide
test
fix
new-feature
update

ブランチ保護

main と develop には保護ルールを必ず設定し、直接 push を禁止します。変更は必ず PR 経由でマージしてください。

次の JSON は GitHub の Rulesets の設定例です。Settings > Rules > Rulesets の「Import a ruleset」から読み込めます。GitLab や Bitbucket では設定方法が異なります。

develop ブランチの保護設定

develop には次の保護ルールを適用します。

  • ブランチ削除の禁止
  • force push(non-fast-forward)の禁止
  • PR 経由でのマージ必須
  • 承認人数: 例では 0 人。案件に応じて 1 人以上に設定する
  • マージ方法: squash と merge を許可。トピックブランチは squash、main からの取り込みは merge を使う(マージ戦略)
  • CI の成功をマージの必須条件にする(CI)
develop ブランチ保護設定
{
  "name": "Develop branch protection",
  "target": "branch",
  "enforcement": "active",
  "conditions": {
    "ref_name": {
      "exclude": [],
      "include": ["refs/heads/develop"]
    }
  },
  "rules": [
    {
      "type": "deletion"
    },
    {
      "type": "non_fast_forward"
    },
    {
      "type": "pull_request",
      "parameters": {
        "required_approving_review_count": 0,
        "dismiss_stale_reviews_on_push": false,
        "require_code_owner_review": false,
        "require_last_push_approval": false,
        "required_review_thread_resolution": false,
        "automatic_copilot_code_review_enabled": false,
        "allowed_merge_methods": ["squash", "merge"]
      }
    },
    {
      "type": "required_status_checks",
      "parameters": {
        "strict_required_status_checks_policy": false,
        "do_not_enforce_on_create": false,
        "required_status_checks": [{ "context": "check" }]
      }
    }
  ],
  "bypass_actors": []
}

main ブランチの保護設定

main は本番環境と同期するブランチのため、develop より厳しい保護ルールを適用します。

  • ブランチ削除の禁止
  • force push(non-fast-forward)の禁止
  • PR 経由でのマージ必須
  • 1 人以上の承認必須(1 人でマージまで完結させない)
  • マージ方法: merge のみ許可(リリース単位の履歴を残す)
  • CI の成功をマージの必須条件にする
main ブランチ保護設定
{
  "name": "Main branch protection",
  "target": "branch",
  "enforcement": "active",
  "conditions": {
    "ref_name": {
      "exclude": [],
      "include": ["refs/heads/main"]
    }
  },
  "rules": [
    {
      "type": "deletion"
    },
    {
      "type": "non_fast_forward"
    },
    {
      "type": "pull_request",
      "parameters": {
        "required_approving_review_count": 1,
        "dismiss_stale_reviews_on_push": false,
        "require_code_owner_review": false,
        "require_last_push_approval": false,
        "required_review_thread_resolution": false,
        "automatic_copilot_code_review_enabled": false,
        "allowed_merge_methods": ["merge"]
      }
    },
    {
      "type": "required_status_checks",
      "parameters": {
        "strict_required_status_checks_policy": false,
        "do_not_enforce_on_create": false,
        "required_status_checks": [{ "context": "check" }]
      }
    }
  ],
  "bypass_actors": []
}

保護ルールのカスタマイズ

プロジェクトの規模やチーム構成に応じて、次の設定を調整してください。

  • レビュー必須人数: develop も required_approving_review_count を 1 以上に設定する
  • コードオーナー承認: require_code_owner_review を true に設定する(.github/CODEOWNERS が必要)
  • ステータスチェック: 例の context は CI のワークフロー例のジョブ名(check)です。ジョブを分けた場合は、必須にするジョブ名をすべて指定する

保護ルールのバイパス

bypass_actors による例外は原則設けません。 履歴の書き換えなどで一時的に必要な場合は、実施者だけを追加し、作業後すぐに外してください。

このページは役に立ちましたか?