Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 5.3 KB

github-storage.md

File metadata and controls

86 lines (54 loc) · 5.3 KB
Raw

GitHub for Code Storage

Week 2 Keywords and Questions

  • What is Git and what is GitHub?
  • What is the difference between Git and GitHub?
  • What is the importance of the README file?
  • What is a remote origin?
  • What does a good commit message look like?
  • What does it mean to “Clone” a repo?
  • What is a branch?
  • What are the steps needed to get my code from my local computer up to GitHub?
  • Why is it important to have a .gitignore file in your project folder?

Prerequisites

Motivation

GitHub is a widely used code storage and code collaboration tool. In this lesson, we cover the storage aspects of GitHub. In another lesson, we'll cover the collaboration aspects.

Objectives

Participants will be able to

  • Explain the difference between Git and GitHub
  • Create their own GitHub account
  • Push code from their local machine to GitHub
  • Identify what should be included in a README

Specific Things to Learn

  • Create a new GitHub repository
  • Link a GitHub repo to a Git repo on your local machine
  • Push a project from your local machine to its respective GitHub repo
  • What makes an effective README

Lesson

  1. Setup and prep: Configure Git and GitHub (10~15 mins)

    • This step configures Git with your name and email, creates an SSH Key, and links your SSH key with GitHub.

  2. GitHub for Code Storage (video walkthrough of slides)

    • Please watch the video the first time without working along with the demonstration. Just absorb the concepts. Then, you can watch the demonstration a second time and code with the instructor if you like.
    • Note: Some of the slides have been updated, please review the slide deck as well for the most current information.

  3. GitHub for Code Storage (slides)

  4. Learn how to create a 'gist' here. You will soon be required to turn many things in with a gist. (Note: It's super easy.)

  5. Art of README (30 minute read)

  6. Use this README.md template to get started. (Sometimes it takes a few reloads to get the page to load)

    • At this point, if you don't have something for a topic like "Tests", just leave it out.
    • Make sure to add a screenshot right after your project description if you have something visual coded up.
    • If you're not sure how to add a photo to a Markdown file, check out this markdown cheatsheet.

Common Mistakes / Misconceptions

  • "The Git repo on my laptop is the same thing as the GitHub repo." The Git repo you may have for a particular project on your laptop gets attached to the GitHub repo you set up to store all its code in. The changes you make in your Git repo on your laptop won't transfer over to your GitHub repo until you run the git push -u origin main command.

  • "I can only push perfect and polished code to GitHub." Lots of people use GitHub to showcase finished projects, but lots of people also use GitHub to store their projects that are in progress. Your code does not need to be perfect, especially as a junior software engineer. If you are really worried about people seeing your code before you deem it "ready", consider upgrading from a free account to the lowest-tier paid plan (currently $7/mo), which allows you to have an unlimited number of private repos. All Techtonica assignments must be pushed to public repos, however.

  • "I just cloned this repo from my own account! Why won't it let me git push?"

    When you git clone github.com/some-name/some-repository, a folder with the name of some-repository will be downloaded to the current directory, and it will already have the remote origin set up as that URL. But you are still in the parent folder; so enter cd some-repository to start working on your cloned project.

    If you are having a problem pushing up to the remote and are getting weird errors like “there is no remote called ‘origin’“, odds are that you are not in your new some-repository folder where the Git data is. Make sure that when you enter pwd (present working directory), it prints that you are definitely in some-folder before ruling out this problem. I still make this mistake sometimes!

Demonstration

In the video walkthrough, the instructor demonstrates the proper GitHub workflow for creating and pushing to repos.

Supplemental Materials

Challenge

Work through this Git and GitHub tutorial for Beginners, which reinforces all of the concepts we covered in this lesson, plus some more advanced topics such as branching, merging, and pull requests. Fun!