Forking/Syncing Cheatsheet

fork_sync.md

Step One - Fork Repo

Following these Forking instructions

1. Go to main/repo and fork it from the top right.
2. Go to your forked repo your/repo (ex. Elucidation/repo) and get the clone address.
3. Clone it on your local machine, ex. git clone git@github.com:Elucidation/repo.git

Step Two - Sync fork to upstream

Following these Syncing a Fork instructions

1. In your local repo, set upstream for syncing with the main repo
2. See current remotes:

$ git remote -v
origin	git@github.com:Elucidation/repo.git (fetch)
origin	git@github.com:Elucidation/repo.git (push)

Note: replace repo with the name of the repo you're interested in

3. Add upstream: git remote add upstream git@github.com:google/repo.git

4. See upstream in remotes:

$ git remote -v
origin	git@github.com:Elucidation/repo.git (fetch)
origin	git@github.com:Elucidation/repo.git (push)
upstream	git@github.com:google/repo.git (fetch)
upstream	git@github.com:google/repo.git (push)

Step Three - Make Changes and keeping in sync

Workflow is :

1. git fetch upstream to note changes on main repo
2. git merge upstream/master to sync local repo to main repo
3. git checkout -b new_branch to create a new branch to make a change
4. Make changes on branch, commit etc as usual (make sure user.name and user.email is correct)
5. Create a pull request through the web interface from main repo to merge changes from fork repo's branch to main repo's master
6. Get +1 from someone else on main repo, make changes as needed locally
7. Merge pull request

Don't I need to 'git pull' or something somewhere in Step Three?

I believe "git remote add upstream git@github.com:google/repo.git" should be "git remote add upstream git@github.com:google/prudaq.git"