Git Workflow

The basic workflow is that developers will be added as contributors to this repository and will all commit to it. This is different than the model where each developer creates a fork of the repository. Do not fork this repo.

Set up your copy of the repo

• First, make sure you have an account on github and send your username to Paul Ray
• Second, clone the repo in your local area. This should ask for your github username and password. git clone https://github.com/paulray/vlite-frb.git

Commit changes to your local repository

Generally you want to commit frequently. Each commit is a set of changes to the files that is logically grouped together. No commit is too small. Each commit has a short commit message that describes what it does. Making a commit with lots of changes is discouraged, as it is hard to describe in a few words and makes the version control git does less useful.

• Edit files in your repo however you like.
• Stage the files to be committed using git add
• Commit the files using git commit, which will ask you to edit the commit message.

Note that this adds the commit to your local repository but does not send anything up to the master repo on github!

Pushing changes up to github

Here is where conflicts between people's edits can occur, so I recommend the following strategy. In general, it is good to synchronize with the github repo frequently, so lots of changes don't pile up.

1. Make sure all your local changes are committed. If you have local changes that you don't want to push into the master repo, use git stash to stash them away temporarily. After you synchronize with github, just say git stash pop to restore those local changes.

2. Pull from the repository and rebase your commits onto any changes that come down. If any conflicts occur, you will have to resolve them.

git pull --rebase

3. Push your commits up to the repo

git push