Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.13 KB

02-git-in-github-instructors.md

File metadata and controls

58 lines (42 loc) · 3.13 KB
Raw

git-in-github-instructors.md

These are notes are for teaching git collaboration through only Github (no local clients). Not putting files onto participants' machines reduced problems that occur from using different operating systems and does not require any local software installation.

Learning Objectives

  1. Define git vocabulary (commit, fork, pull request, repository, commit message).
  2. Demonstrate ability to navigate through a Github repository main page.
  3. Define the difference between a directory and a repository.
  4. Create a repository on GitHub.
  5. Demonstrate ability to commit changes to text files with a commit message.
  6. Evaluate repository History.
  7. Create a pull request to someone else's repository.

Brief introuction showing them how our rrhack group collaboratively made our curriculum material.

Activity

Total time: 45 minutes

Create a repository with a README.md file

Follow along (15 minutes)

  • Everything is isolated to a README.md file.
  • Have everyone go to their GitHub profile page (Everyone should already have a GitHub account, because you included that in the setup instructions for the workshop, right?)
    • Introduce the main features of the home page.
  • Create new repository.
    • call it work-organization-yourName
    • In the details write "tips to organizing research".
    • make sure they initiate a README.md file. Once the repository was created, again show them around the page, highlighting that they have made one commit with the addition of the README.md file and explaining that all that they are looking at is a directory with one file.

Edit the README.md file (10 minutes)

  • Edit the file. Click on README.md, then click "edit this file".

  • Add the following information into the readme.md file (allow ~10 minutes):

    • Name?
    • What kind of scientist do you you tell people you are at dinner parties?
    • In the past month, what are the three main activities you have been doing at work?
    • What are the three most important tools/strategies you use for organizing your work?

    Encourage them to practive markdown syntax use at least one hyperlink, bullet point/number set, and a header. Do guide them to the preview changes option to help them along, and paste this Markdown help link into the etherpad.

Part 3 - Follow along (15)

  • Commit.
    • Talk about commit messages.
    • Show them where the repository is. Show them the repository has a url address that is composed of their user name and repository name.
  • Fork a partners Github repository.
    • The easiest way to have them find each other is typing directly into url. The search for user option only works if they verified their address through email and many times they do not.
  • Edit forked repository by pasting in their questions below the originals. Commit.
  • Create Pull request.
  • Accept pull request.
  • Look at cool Github features.
    • Look at Blame, Issues, Wiki, Repo graphs, ect.. Show another cool repository example, like maybe the ReXML repository.
  • Get excited about collaborating on Github.