Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 3.39 KB

starting_with_a_branch.md

File metadata and controls

95 lines (61 loc) · 3.39 KB

Using branches

As you start each sprint in this series you are strongly encouraged to:

  • start from the previous solutions and build on them
  • do your work on your own new local branch

Initial setup

Follow these steps immediately after you first fork and clone the repository.

This project is carrying on throughout the week, so there may be changes to the class version of this repository after you clone. To make it easy for you to get updates, you should add the class version as an extra remote repository.

  • In GitHub, copy the clone url of the class version of this repository. Back in your Terminal, navigate to your local repository for this project. Run the following command (paste in the class repo clone url instead of typing CLASS_REPO_CLONE_URL):

    git remote add upstream CLASS_REPO_CLONE_URL

  • In the future, if your teaching team asks you to get class updates for a specific branch, you can pull updates from the upstream remote. Try this now with the master branch (there shouldn't be anything new on master yet):

    git checkout master
git pull upstream master

First sprint

Follow these steps only on your first sprint!

  • For sprint 1, after you clone the repo, make sure you're on a personal local branch.
git checkout -b my_work_sprint_1

git checkout -b creates a new, local branch from the current branch.

Subsequent Sprints

Follow these steps on every sprint except the first one!

Why? You likely have changes from previous sprints that need to be committed first! Plus, you'll want the most recent version of the starter code each sprint!

Let's assume you're starting sprint 2

  1. Save your changes to any files you've been working on.

  2. Make sure you're on a branch for your work. The git branch command should show you being on your branch for the previous sprint (e.g., my_work_sprint_1).

  3. Commit any changes you've made.

    git add .
git commit -m "saves final changes on sprint 1"

    Then verify that the above worked. If git status shows that your working directory is clean, you're good to go!

  4. If you want to be sure you have the most recent version of each sprint's instructions, you should update your master branch. Now is a good time

    git checkout master       
git pull upstream master  # get your local master up to date with any doc changes
git push origin master    # make sure your GitHub copy is up to date, too!

  5. Check out the solution branch for the sprint you were previously working on using git checkout BRANCH_NAME.

    git checkout solutions_sprint_1

    If you're starting sprint 2, use the solutions from 1 as your starting point.

    If that command didn't work for you, try this version that tells git your new solutions_sprint_1 branch should match upstream/solutions_sprint_:

    git checkout -b solutions_sprint_1 upstream/solutions_sprint_1

  6. Pull any changes to the branch from upstream, and push them to your origin:

    git pull upstream solutions_sprint_1
git push origin solutions_sprint_1

  7. Create a new branch for your work in this sprint.

    git checkout -b my_work_sprint_2

    git checkout -b creates a new, local branch from the current branch.

  8. Begin working! Make all your commits on YOUR branch.