開発の流れ(git hubの使い方) - tyumu/FitChase GitHub Wiki
Unity開発 × GitHub運用ガイド
このドキュメントは、UnityプロジェクトをGitHubで管理する際の基本的な流れを、コマンドベースで解説するもの。
リポジトリのクローンは完了している前提で進める。
1. ブランチを切る
作業前に、メインブランチから自分用のブランチを作成。 ブランチの名前は 自分の名前/develop/自分が担当するissue番号
issue番号はissueに書いてある#○のこと
###例
git checkout -b kajiwara/develop/issue13
サブIssueがある場合のブランチ構成
親Issue用にブランチを切ったあと、サブIssue用の作業ブランチは親Issueブランチから派生させる。 サブIssueをまだ書いていない場合はissueについてを参考に書いてから次に進む
例:
git checkout -b kajiwara/develop/issue○× # 親Issue用ブランチ
git checkout -b kajiwara/develop/issue△○ # サブIssue用ブランチ(↑から派生)
kajiwara/develop/issue△○
で作業し、完了したらkajiwara/develop/issue○×
にマージ- 全てのサブIssueが終わったら、
kajiwara/develop/issue△○
をmain
にマージ
2. 作業&コミット
Unityで作業したら、以下の手順で変更を記録。
まず自分がどのブランチにいるかを確認する。
git branch
*
がついている行が現在のブランチ。
git status # 変更確認
git add . # すべての変更をステージング
git commit -m "コミットメッセージ 作業内容を簡潔に書く"
Git Bashではプロンプトに現在のブランチ名が表示されるため、ブランチの確認がしやすい。windowsキー押して検索したら多分出てくる
コミットメッセージ
1.何をしたかを書く
- add 機能追加
- modify 機能修正
- wip わからない場合
2.issue番号を書く
自分が担当しているissue番号を書く
3.変更した内容の概要を書く
コミットメッセージの例
[add] #6 ⚪︎⚪︎を実装
3. プッシュ
自分が今いるブランチを確認した上で、リモートに変更を送る。
git branch # 念のためブランチ確認
git push origin kajiwara/develop/issue△○
4. プルリクエスト(Pull Request)を作成するタイミング
単独のIssue対応なら
- 作業ブランチ →
main
へ直接PR(レビュー後マージ)
サブIssueがある場合
- サブIssueの作業ブランチ → 親IssueブランチにPR
→ 親Issueブランチ →main
に最終的にマージ
画像は
develop/yanai/issue-15
ブランチをrelease
ブランチにマージするリクエストをしている
- サブIssueごとにPRを分けておくとレビューしやすく、履歴も明確になる
5. レビュー・マージ
- PRを作成したら、レビュワーにレビュー依頼
- 指摘がなければマージ
- 「Squash and merge」を使うとコミット履歴が整理されて見やすい
6. メインブランチの最新化
作業が終わったら、メインブランチに戻って最新状態を取得。
git checkout main
git pull origin main
7. .gitignore の重要性
Unityでは以下を.gitignore
に追加しておくと不要ファイルの混入を防げる。(もう作ってるので作成する必要はない)
とりあえず.gitignore
は消さないこと
例(抜粋):
[Ll]ibrary/
[Tt]emp/
[Bb]uild/
[Bb]uilds/
obj/
*.csproj
*.unityproj
*.sln
*.user
8. よく使うGitコマンドまとめ
コマンド | 説明 |
---|---|
git status |
現在の変更状況を確認 |
git branch |
現在のブランチを確認 |
git add . |
全変更をステージング |
git commit -m "msg" |
コミットを作成 |
git checkout ブランチ名 |
ブランチを切り替える |
git checkout -b 新ブランチ名 |
新しいブランチを作成 |
git push |
リモートに反映 |
git pull |
リモートから取得・更新 |
git log |
コミット履歴を確認 |
9. 注意点
- Unityエディタで作業する前に必ずブランチを切る
.meta
ファイルは消さない(Unityで必要)- 競合が起きたら落ち着いて
git status
→git merge
→手動解決
- Git Bashのようにブランチ名が常に表示される環境を使うとミスを減らせる
- サブIssueがあるときは「親ブランチにマージ → 親をmainへ」が基本の流れ