Using GitHub

What is GitHub?

GitHub is a version control service that allows many people to collaborate on a single code base. These code bases are called repositories. RobOrchestra uses GitHub to document all project code and mechanical diagrams. If you're working on RobOrchestra, its a good idea to bookmark our repository: https://github.com/CMU-Robotics-Club/RobOrchestra for quick reference.

Setting up GitHub

If you're planning on contributing to the RobOrchestra project, go through the following steps to set up GitHub on your computer

• Go to https://github.com/ and create an account. Email sadkins@andrew.cmu.edu with your username so you can be added as a contributor to the RobOrchestra repository.
• Download the GitHub Desktop Application and install it. Once it has been installed, restart your computer.
• Navigate to the online RobOrchestra GitHub Repo and click the green "Clone or download" button. Then select the "Open in Desktop" option. This will open the RobOrchestra repo in the GitHub Desktop application, which will walk you through the steps of cloning the repository to your computer.
• You now have the entire RobOrchestra code base and all documentation saved locally on your computer!

Using GitHub

If you are new to Github, check out the Hello World GitHub Tutorial and this helpful GitHub Desktop Tutorial. For the purposes of RobOrchestra, the most important things you need to know how to do are how to commit your changes and how to sync with the "master" branch in the Github Desktop Application.

Syncing

You have the RobOrchestra repository saved locally on your computer, but it doesn't automatically update. To update your local copy of the repo to the current online version, you must sync with the master branch. To do this, simply click the sync button in the top right hand corner of GitHub Desktop.

Committing Changes

When working with RobOrchestra code, always work with it locally on your computer. When your code is fully functional, you can upload your changes or your new files to the master branch by "committing." To do this, go to the Changes tab in GitHub desktop. You will see a list of differences between your local code and the master branch. In the summary box, give a quick overview of what your new code does or what you changed, and give more details in the description box if necessary. Then click "commit to master". After committing your changes, sync with the master branch as described in the above section.