##Lesson 00 - GitHub and version control
###Learning Objectives:
- Define a version control system (Git) and explain its benefits
- Initialize a local git repository and explain what it does for a developer
- Push local changes to a remote git repository using the GitHub app
- Pull changes from a remote git repository to a local computer using the GitHub app
- Connect local repositories to remote repositories using the GitHub app
| Section | Timing | Description |
|---|---|---|
| Opening | 10 mins | What is Git / GitHub? |
| We Do | 15 min | Set up your first GitHub repo with GitHub app |
| Closure | 10 min | Review work flow; Explain Git / GitHub benefits |
###Connection to a long term learning goal
GitHub is a tool that is vital to developers. GitHub allows developers to work collaboratively and asynchronously and gives developers a way to store code history. In the context of this class, students will use it as a tool to submit assignments and download files. Throughout this class, instructors will use it to assess and review student work and provide feedback.
###Before Class (Student Pre-work)
Students are required to follow the steps in the GitHub guide included in this folder before class. They are also required to watch the GitHub video. This lesson will help refresh students on this process and also serve as an opportunity to answer any questions.
Before class - students should send the instructors the following via email, Slack or Schoology (if your market uses it):
- Their GitHub username
- A link to their first repo
#Lesson Outline
##Opening: What is GitHub? - 10 minutes
####Some important vocabulary relating to Git/GitHub
- git - a version control program that saves the state of your project's files and folders; basically, it takes a "snapshot" of what all your files look like at a moment and stores a reference to that "snapshot"
- Note: you may want to compare git to an organizational backup tool used to save and organize work; be wary of your class' experience and try not to introduce too many industry-specific vocabulary
- repository - a central location in which data - typically about a project - is stored and managed
- clone - download data from the cloud to your local machine (laptop, computer, etc.)
- commit - save a version of your project to git
####What is GitHub?
- GitHub is a platform makes it easy to manage git repositories. It is now commonplace in any company that works with engineers.
- Stores files like Dropbox or Google Drive, but stores code.
- Stores a history of files and the changes that happens within each changed document.
- Hosts files on the cloud so you can share the finished product with other people.
- Git - the technology that Github is based on top of - was designed to allow for multiple engineers to work on the same project.
####Why is GitHub Valuable? Why do developers use GitHub?
- Since GitHub stores a history of the code, it allows developers to go back in time if something breaks.
- GitHub allows multiple developers to work on the same project. Much like Dropbox or Google Drive lets multiple people collaborate on the same document, GitHub allows this for code.
- GitHub tracks changes so you can see who worked on what.
- GitHub allows for feedback to be given on the code, which hopefully, increases code quality. Much like an editor updates a Word document using Track Changes, GitHub allows a similar environment.
####How does GitHub work in a collaborative environment?
GitHub's collaborative process can work many different ways, but this is the most common:
- Each GitHub project is called a "repository". Engineers joining a team start by "cloning" the repository (or repo, for short).
- Remember: "Clone" means that we are copying our GitHub repository from the cloud and saving it as a local folder on our computer.
- The main, stable version of the codebase is on the default "branch" in GitHub which is called "master".
- Engineers typically create new branches for certain features or portions of the code they will work on, but we won't be creating branches in this class in this class.
- As engineers are working on a project, they "add" and "commit" their changes. This establishes a saved version of a project and creates a history of what they are working on. With these saved versions, engineers are able to revert to an earlier version if an issue arises that cannot be fixed.
- If there are multiple engineers working on a project, other engineers can review the code that is committed and provide feedback. For this class, the instructors will be reviewing and providing feedback on your code.
- We will be working with our own default "master" branch for each of our projects.
##We Do: GitHub Refresher/Setup a repo - 15 minutes
- Log on to GitHub.com and press the big green button for "New Repository".
- Finish setting up the repo by adding a name to the repository. The default settings (public, no organization, no readme) are fine. Name your repository "cookie_recipe".
- Add our website’s files to it. To get started, click on the “Set up in Desktop” button. This brings everyone back to the GitHub App.
- When the app opens, a message should pop-up that says “Clone As” with the name of our new repository pre-entered.
- CFU: The Instructional Team should go around and confirm that each student has this message on their screen.
- Save the repository to wherever you saved your FEWD class folder.
- Let's add files and folders to your project. At this stage, you won't have any of your own projects, but you do have the starter code from today's class (which you can distribute to students ahead of time via email or Slack). Open up Finder and drag the contents of the cookie_recipe project starter code to your first repo's corresponding local folder. Make sure you don't include the cookie_recipe folder, just the contents of that folder.
- NOTE: You should always preserve directories (folders) when dragging files in.
- Go back to the GitHub app and select the "Changes" tab. As a "commit message" for now, you can just put “syncing my new repository!”, but as you do other projects you will want to commit frequently and your commit messages might look like “changed the background color and logo size per client’s request.”
- Hit the "Commit and sync" button at the bottom and then the "Publish" button.
- Go back to GitHub.com and refresh your repository page. You should now see the cookie recipe's files inside.
- CFU: The instructional team should verify that everyone in the class has a repository called cookie_recipe (or similar) with the cookie recipe files inside of it on GitHub.com.
- Now that you've seen how to create a new repo, add files to it and push those files up to GitHub, it's time to see how we'll be using the class repo to receive files and code from our instructors. Using the same process that we used to 'clone' our own repo, go ahead and clone the class repo (the instructional team should send the link to the class repo out via Slack--if there are students who don't yet have access, make sure to connect them with the producer in order to get them added).
- Practice using the "sync" button in order to pull in the latest changes from the class repo (the instructional team can add a demo file to the repo in order to demonstrate this).
- CFU: The instructional team should verify that everyone in the class has successfully added the class repo to their GitHub app. Any students who don't yet have access to the repo should be connected with the course producer, who can add them.
##Closure: Reviewing GitHub work flow; Explain Git/GitHub benefits - 10 minutes
- Walk students through the homework submission, grading and feedback process (i.e everything that's explained in the FEWD GitHub work flow document)
- Also, quickly show students where they can access in-line comments on their commits left by the instructional team:
- Use this video to show students how to navigate their GitHub account to access in-line comments
- Afterward, point out that they will also get an email alert when they have a new comment on their code:
