Skip to content

Using Github Desktop

chrisjuchem edited this page Oct 1, 2018 · 2 revisions

Git is how we manage changes across different features and computers without stepping on each other's toes. To make things go smoothly, every feature that gets worked on should be worked on in its own branch.

Branches

Branches provide each person with their own environment to work without needing to deal with half-finished work from others. The master branch is the polished version of the game. Features are only merged into master once they are completed (Chris or Alex can handle this part).

When you start working on something in Unity, open Github Desktop and choose your branch by clicking in the button that says Current branch and choosing the branch you want/creating a new one (when creating a new branch, it is a good idea to switch to master first. Make sure you click Fetch origin at the top to get any recent changes on your branch.

If changes from another branch have been completed and merged to master, you can merge them into your branch by navigating to Branch > Merge into current branch and choosing master. You can also pull in any other branch if you need to build on top of someone's work-in-progress feature. When you are finished with a feature, you should use this process to pull in the latest features from master to test that everything is still working and nothing recently added to master is incompatible with your feature.

Commits

Commits are individual chucks of changes. Others will not be able to see any work you have done unless you commit and push it.

To commit your work, first double-check the branch you are on is the one you intend to commit to. You should never commit to master. On the left side of Github Desktop, you will see a list of all the files you have changed. Usually, you'll want to commit everything, but if you want to omit anything (possibly to save it for a later commit) you can do it here. Fill in the Summary field with a short description, then click Commit to <your branch> (Again, it shouldn't say master). Finally click Push origin at the top to allow others to see your commits.

Clone this wiki locally