git workflow - yamashin-Haco/gittest-wiki GitHub Wiki

Git ワークフロー(初心者向け)

このページでは、誰でも同じ手順で作業できるように、Gitの基本運用ルール(ブランチ/PR/大きなファイルの扱い)をわかりやすくまとめています。

目的(短く)

  • コンフリクトを減らし、レビューしやすいPRを作るためのルール。

基本ルール(最初に覚えること)

  • メインブランチ: main(安定)
  • 開発ブランチ: develop(ある場合)
  • 個人作業は feature/ または hotfix/ を使います。

ブランチ命名(例)

  • 新機能: feature/<短い説明>(例: feature/coin-system)
  • バグ修正: fix/<issue番号>-<説明>(例: fix/123-fix-crash)
  • 緊急修正: hotfix/<説明>

ローカルでの基本コマンド(初心者向け)

  1. リポジトリを最新化:
    • git fetch origin
    • git checkout main
    • git pull origin main
  2. 新しいブランチを作る:
    • git checkout -b feature/your-topic
  3. 作業をコミット:
    • git add .
    • git commit -m "短い説明: 何をしたか"
  4. リモートにプッシュ:
    • git push -u origin feature/your-topic

PR(プルリク)を出すときのチェックリスト(PR作成前に必ず確認)

  • main(または対象ベース)を最新にマージ/リベースした
  • ビルドが通る(ローカル確認、可能ならCI確認)
  • テスト(自動/手動)を実行した
  • 変更内容が簡潔に説明されている(何を・なぜ)
  • レビュワーを指定した(最低1人)
  • LARGE FILES(アセット等)がLFSに入っているか確認した

PRテンプレート(そのままコピペして使ってください)

概要

  • 何をしたか(1文)

実装の内容

  • 詳細(箇条書き)

チェックリスト

  • ビルドが通った(Editor/CI)
  • テスト(Unit/PlayMode)を実行した
  • 影響範囲を確認した(各プラットフォーム)
  • LFS を確認した(大きいアセット)

関連Issue

  • fixes #(あれば)

備考

  • 注意点や既知の問題

Git LFS(大きなファイル)の扱い(簡単)

  • 画像/音声/動画など、一定サイズ以上(例: > 5MB) はLFSを使うルールにしてください。
  • .gitattributes で管理(例: *.png filter=lfs diff=lfs merge=lfs -text)
  • LFSファイルはクローン時に別途ダウンロードが必要なことを共有する

よくあるトラブルと対処(短く)

  • コンフリクト多発 → 小さな単位で頻繁にPRを出す
  • LFSの容量上限エラー → アセットの分割、不要な履歴削除
  • rebase/mergeで迷ったら → 一度チームに相談して標準化
⚠️ **GitHub.com Fallback** ⚠️