GitHub Desktop Tutorials

Using GitHub during Sprints

How it all works

GitHub stores a master copy of your team's project on there website. When you want to work on the project you sync or pull newer versions of the project to your computer. Any changes you make to the code has to be uploaded or pushed to the GitHub repository through a process called Commit.

Step-By-Step

Before writing code

    Note: Anytime you want to start working on your project, make sure that you always have the newest version before coding. This is done by pulling or syncing any new code from GitHub.com to your local computer.

  1. Click "Sync" in the right-hand side of GitHub Desktop
    2. Sync button is on the top right-hand side of application.
  2. You will then see the button stating syncing and if something new was synced you will see the update.

You have written code, and are ready to sync with your GitHub repository

    Note: You should always upload your code to your repository when you stop writing code for the day. It doesn't have to work, but make sure your code doesn't break the functionality of other people's code. I recommend looking into automated testing to help prevent broken code.

  1. Launch GitHub Desktop if not already open
  2. In the top-center, click Uncommited Changes.
    3. Uncommited Changes is on center top next to history tab.
  3. This shows what you have changed, but haven't uploaded or pushed to your team repository.
    4. Example of changed code before commit.

    Suggestion: I recommend before continuing to notify your team that you are about to push your code. This helps avoid an issue called merge conflict. We will discuss this a little later.

  4. Click "Sync" again from the top right-hand side.
    5. Sync button is on the top right-hand side of application.

    Note: Before commiting it is best to click sync to make sure nothing new has been updated or changed from the repository.

  5. Under the column that says "Changes", select the "Summary" input field and type a summary for your changes.
  6. If need additional space, click on "Description" to enter more details.
  7. Click "Commit to master"
    8. Example of documenting changes made.
  8. Click "Sync" again from the top right-hand side to finalize commit.
    9. Sync button is on the top right-hand side of application.
  9. If you go to your GitHub repository, you should now see your updates.
    10. Image of project repository on Github.com.