Skip to content

Desktop Github

Introduction

It's a fast, easy way to contribute to projects from OS X and Windows.

GitHub Desktop is designed to simplify essential steps in your GitHub workflow and replace GitHub for Mac and Windows with a unified experience across both platforms.

GitHub Desktop is an open-source Electron-based GitHub app.

Installing and Authenticaticating to Github Desktop

Before you set up GitHub Desktop, you must already have a GitHub account.

Download & Install Desktop GitHub

You can install GitHub Desktop on supported Microsoft Windows or macOS operating systems.

github desktop

  • In your computer's Downloads folder, double-click GitHub Desktop.
  • In the pop-up window, click Install.
  • After the program has been installed, click Run.

📖 Tutorial for Windows and Mac Users

Setting up Desktop Github

After you've launched GitHub Desktop, you can choose to set up GitHub Desktop right away.

  • You will be asked to sign into Github.

sign up

  • Once you sign in, you will need to approve permissions.

auth github

Authenticating to Github

  • In the upper-left corner of the window, select the File menu.
  • Click Options

auth1

  • In Options -> Select Accounts

auth2

  • In the Accounts pane:

    • To authenticate to GitHub, under "GitHub.com" click Sign In.
    • Use the Github Username and password.

auth3

📖 Authentication Tutorial

Configuring Basic Settings

  • In the upper left corner:

    • File -> Options
    • Options -> Accounts: to add or remove a GitHub account
    • Options -> Integrations: to pick an external editor or shell.

    integrate

    • Options -> Git: to edit your Git configuration.

    git

    • Options -> Appearance: to switch between the light or dark theme.

    appearance

    • Options -> Advanced: for more configuration options.

    advanced

📖 Configuration Tutorial

Cloning a Repository from Github to Github Desktop

There are 2 ways to clone repositories:

Use GitHub to clone remote repositories to GitHub Desktop

  • Sign in to Github and Github Desktop before you start to clone.
  • On Github, navigate to the main page of the repository.
  • Above the list of files, click "Code".

clone1

  • Click on "Open with Github Desktop"

clone2

  • Click "Choose", navigate to local path where you want to clone the repository.
  • Click on "Clone"

clone3

Cloning in Desktop Github

  • Click on Current Repository tab
  • Click Add -> Clone Repository

clone

  • A dialog box will appear with list of repositories you are part of.
  • Choose the repository you want to clone.

choose repo

  • In Local Path: choose the location on your system where you want to clone the repository.
  • Click Clone

repo path

Repository Cloning Help

Creating a Branch

You can create a branch off of the repository's default branch so you can safely experiment with changes.

You always create a branch from an existing branch. Typically, you might create a branch from the master branch of your repository. You can then work on this new branch in isolation from changes that other people are making to the repository.

  • At the top of the app, choose your working repository, in the Current Repository tab.
  • Click on Current Branch tab.
  • Click on New Branch

branch1

  • Add name of branch.
  • Click on Create branch.

branch2

Branch Help

Making Changes to Branch

Using a text editor, such as Visual Studio Code, make the necessary changes to files in your project.

Committing changes to your project

As you make changes to files in your text editor and save them locally, you will also see the changes in GitHub Desktop.

Similar to saving a file that's been edited, a commit records changes to one or more files in your branch. Git assigns each commit a unique ID, called a SHA or hash, that identifies:

  • The specific changes
  • When the changes were made
  • Who created the changes

  • Select the branch you have made changes to.

  • Select changes to include in a commit

    • The red '-' icon indicates removed files.
    • The yellow '.' icon indicates modified files.
    • The green '+' icon indicates added files.
    • To access stashed changes, click Stashed Changes.

commitchanges

  • Write a Commit Message : at the bottom of the list of changes, in the Summary field, type a short, meaningful commit message. Optionally, you can add more information about the change in the Description field.

  • Under the Description field, click Commit to Branch.

commitdesc

Commit Help

Push Changes

As you commit changes to your project locally, you can push those changes to GitHub so that others may access them from the remote repository.

When you push changes, you send the committed changes in your local repository to the remote repository on GitHub. If you change your project locally and want other people to have access to the changes, you must push the changes to GitHub.

  • Click on Push origin : to push your local changes to the remote repository.

pushorigin

  • Click on Create Pull Request : to open a pull request and collaborate on your changes. This will send email notification to the reviewer.

pullrequest

📖 Push Changes Tutorial

Help & Guides

To do List

To mark the training complete, finish the below tasks:

  1. Clone a test repository.
  2. Create a test branch.
  3. Commit changes made to the branch.
  4. Do a Pull request on the branch.

Last update: August 10, 2020