Repository navigation
Getting Set Up
This will show you how to download the repo, and also how to use some basic git commands to make contributions.
Use git bash (or a terminal) and navigate to a directory to clone the repo. Run the following command:
git clone --recurse-submodules https://github.com/RegrowthStudios/SoACode.git
http://www.microsoft.com/en-us/download/details.aspx?id=43729
Finally just open the .sln file and you should be able to build and run the game!
You can call your branch feature/<name_of_feature> if is is a feature, or bugfix/issue_id_some_issue_description if it is a bug fix. To create a feature branch, run the commands:
git branch feature/<name_of_feature>
git checkout feature/<name_of_feature>
To grab all the branches from the remote so that you can test and contribute to your peer's branches, use:
git fetch --all
Then make sure they are up to date with:
git pull --all
This will pull all refs onto your machine. To see a list of branches, use:
git branch -a
Branches that you do not have a local copy of are red and are probably prepended with /remote/origin/. You can checkout a specific branch with:
git checkout -b branchName
For example:
git checkout -b remote/origin/testBranch
If you would like to update the submodules for SoACode, use the command:
git submodule update --recursive
To get the most recent changes from your branch, run the command:
git pull
To get the most recent changes from the remote develop branch, run the command:
git pull origin develop
If you get any conflicts, be sure to fix them and then commit the fix.
To add files to the repository to be tracked, use:
git add filename
To remove a file from the repo and delete it use:
git rm filename
To remove a file from the repo but keep a local copy use:
When you are ready to commit your changes, simply run the command
git commit -am "your commit message"
To push your changes to the remote branch, if it is your first commit on mybranch, use:
git push --set-upstream origin mybranch
Otherwise, use:
git push origin mybranch
When you are ready to merge your changes with the develop branch, simply make a pull request by clicking the pull request button on the github page.