Cheat Sheet GitHub

Git LFS

Git can work fine with 3D games out of the box. However the main caveat here is that versioning large (>5 MB) media files can be a problem over the long term as your commit history bloats. Maybe use DropBox for art assets.

Regular Branching

Development branch (also called ‘develop’) : This is your main development branch where all the others branches (e.g. feature branches) will be merging into this branch.
Production branch (also called ‘master’) : This branch represents the latest released / deployed codebase. Only updated by merging other branches into it.
Feature branches (also prefixed with ‘feature/’) : When you start work on anything non-trivial, you create a feature branch. When finished, you’ll merge this branch back into the development branch.
Release branches (also prefixed with ‘release/’) : When you’re about to package a new release, you create a release branch from the development branch. You can commit to it during your preparation for a release, and when it’s ready to be deployed, you merge it into both the development branch and the master branch.
Hotfix branches (also prefixed with ‘hotfix/’) : If you need to patch the latest release without picking up new features from the development branch, you can create a hotfix branch from the latest deployed code in master. Once you’ve made your changes, the hotfix branch is then merged back into both the master branch and the development branch.

Unity Project : Github Settings

For versions of Unity 3D v4.3 and up:

(Skip this step in v4.5 and up) Enable External option in Unity → Preferences → Packages → Repository.
Open the Edit menu and pick Project Settings → Editor:
- Switch Version Control Mode to Visible Meta Files.
- Switch Asset Serialization Mode to Force Text. (By default already)
Save the scene and project from File menu.

Unreal Project : Github Settings

TODO

Acknowledgements

Based on the following blog posts :

Ce(tte) œuvre est mise à disposition selon les termes de la Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International.

PreviousGit_Flow_Example NextUseful commands

Last updated 6 years ago

Was this helpful?

Regular Branching

Development branch (also called ‘develop’) : This is your main development branch where all the others branches (e.g. feature branches) will be merging into this branch.

Production branch (also called ‘master’) : This branch represents the latest released / deployed codebase. Only updated by merging other branches into it.

Feature branches (also prefixed with ‘feature/’) : When you start work on anything non-trivial, you create a feature branch. When finished, you’ll merge this branch back into the development branch.

Release branches (also prefixed with ‘release/’) : When you’re about to package a new release, you create a release branch from the development branch. You can commit to it during your preparation for a release, and when it’s ready to be deployed, you merge it into both the development branch and the master branch.

Hotfix branches (also prefixed with ‘hotfix/’) : If you need to patch the latest release without picking up new features from the development branch, you can create a hotfix branch from the latest deployed code in master. Once you’ve made your changes, the hotfix branch is then merged back into both the master branch and the development branch.

Unity Project : Github Settings

For versions of Unity 3D v4.3 and up:

(Skip this step in v4.5 and up) Enable External option in Unity → Preferences → Packages → Repository.

Open the Edit menu and pick Project Settings → Editor:

Switch Version Control Mode to Visible Meta Files.
Switch Asset Serialization Mode to Force Text. (By default already)

Save the scene and project from File menu.