Using Github for project management

A brief tutorial

Matthew Crump

10/31/2019

Overview

  1. What is git and github?
  2. Getting started with Github
  3. General tips

Git

Github

Get your free github account

Sign up at https://www.github.com

Download Github Desktop

Download the version for your operating system https://desktop.github.com

Connect Github Desktop to your Github Account

Open Github Desktop, open the Preferences menu, then sign in with your Github Account.

Keeping (g)it simple

Normal folders and git folders

Git folders look like normal folders, but have hidden .git files

git folders

Git Folders store history of changes (version control)

git master and branches

Can have multiple branches

usually for development purposes

git basics

  • Make changes to files
  • “Commit” the changes
  • git updates current version
  • and saves the previous version

git + github

  • copy from local to Github.com
  • “push” to Github.com
  • “pull/sync” from Github.com

Looks complicated, but…

Complicated at first but…

  • Relatively easy with Github Desktop
  • Similar to Dropbox, but with commit notes
  • let’s get to some examples…

Create a new git folder from RStudio

Add new repo to Githup Desktop

Github Desktop (view and manage your repos)

Commit then publish

Publishing to Github.com

Viewing your repo on Github.com

Work on your files

Commit new changes in Github Desktop

Publish them to Github (if you want to)

Changes appear on Github.com

That’s Github in a nutshell

Before moving on the next module…

A few more tips

Making new local repos

Cloning and Forking

From Github.com, if you have a Github account

Cloning

Forking

Github Issues

Normally used to report and address “bugs” in software, but can be used as useful way to have discussions (with collaborators or yourself) about project-related tasks:

Github Pages + OSF integration

We’ll talk about Github Pages and OSF (open science framework) integration in later modules. Short story is that: