Skip to content
This repository has been archived by the owner on Dec 12, 2020. It is now read-only.

Getting started with GitHub and Todo.txt Touch

Jesse Gennrich edited this page May 30, 2013 · 2 revisions

Assuming you have git installed and configured, you will be wanting to get your own fork, and getting it locally.

Look to the GitHub Guide for help on this: Fork A Repo

We suggest following the two first steps here; First: Fork A Repo and Next: Set Up Your Local Repo

In order to keep your repository in sync with the master repository (Gina's), we suggest working on each feature and bugfix in its own branch. In this way it is easier to update your code with changes that may come from other developers, using git rebase.

An additional usage of git rebase that helps keep the code tree clean: Squash all commits related to a single issue into a single commit

Example Workflow

# update your local copy of master
git fetch upstream
git rebase upstream/master master

# create and switch to new branch
git checkout -b 100-new-feature-branch

#do lots of work and commits

# update your working branch with changes from others
git fetch upstream
git rebase upstream/master master
git rebase master 100-new-feature-branch

#do lots of work and commits

# create a release candidate branch
git checkout -b 100-new-feature-branch-rc

# squash your (say seven) commits into one for legibility -- getting rid of the "oops, forgot one" commit messages
git rebase -i HEAD~7

#push your changes
git push origin 100-new-feature-branch-rc

#create the pull request, win and 4. PROFIT!!! :)