Update: This gist is from when I was a student participating in UCOSP and helped me to plan and keep track of my progress on Freeseer.
This public gist is for team members and myself to keep track of what I'm working on, what I plan to work on, and to read any miscellaneous notes or tips about the project I feel are worth adding.
Comments and reviews are welcome and encouraged!
Clone the remote origin repos (master & experimental) to separate directories on your local machine
$ git clone git@github.com:fosslc/freeseer.git freeseer
$ git clone -b experimental git@github.com:fosslc/freeseer.git freeseer-experimental
$ cd freeseer-experimental
Create a new local branch based off experimental for your feature, and switch to it.
$ git branch --track experimental origin/experimental
$ git branch myfeature experimental
$ git checkout myfeature
or
$ git checkout --track mynewfeature origin/experimental # A shorter way of doing it
Add a remote named “fork” that points to your private fork on GitHub (remote fork)
$ git remote add fork git@github.com:myusername/freeseer.git
Fetch any changes from your remote fork (optional)
$ git fetch fork
Push your new local branch to the remote fork, where it should have the same name
$ git push fork myfeature:refs/heads/myfeature
Configure your new local branch so that it automatically pushes changes to your new remote branch on GitHub when we do a plain git push, and automatically pulls from your branch on the remote fork when we do a plain git pull
$ git config branch.myfeature.remote fork
$ git config branch.myfeature.merge refs/heads/myfeature
So you can pull changes from origin directly to your local copy, with the assurance that those changes will be automatically migrated to your remote fork repository when you push.
Most of these tips are from zxiiro in #freeseer
always make your own branch
always rebase your branch against upstream's development branch (or working branch whichever it is)
when your code is done and ready to be pulled send a pull request to upstream, and if your going to work on something else, make a new branch again off of upstream's development branch to work on your new project (when they pull your original branch, then when you rebase the new upstream working branch, your new branch will have the feature you added - makes merging much easier)
rebase often if you're pulling from upstream
it's cleaner to rebase than fetch and merge
you can't rebase if you've already pushed your changes onto github
push when done working for the day, and pull before start working
The import branch is a local branch of incoming code which parallels the remote development branch. NEVER make changes in this branch! That way it stays trivial to update it with "git pull". (It's possible to pull direct from upstream without creating a local branch, but this is handy for comparing even when offline.)
Create a local branch (e.g. 'mybranch') that pulls from 'import':
$ git checkout -b mybranch import
For merges, you want to be in the branch you're bringing content into:
$ git checkout master
$ git merge mybranch # Merges the commits from "mybranch" into "master"
$ git branch -d mybranch
To get the latest code (from upstream) when online:
$ git rebase upstream/development import # Do this often
or
$ git checkout import # Make 'import' the active branch
$ git pull # Merges any pulled commits into the current branch
Once you have the latest code in your import branch, you can then update your working branch with:
$ git rebase import mybranch # Do this often
When you're done working for the day, push your branch back up to your fork so that the changes are visible & preserved:
$ git push origin mybranch:mybranch # After the first time, you can simply use 'git push'
Make sure to commit and push often! Cheap and quick way to preserve your work. Changes can always be undone.
When one of your commit fixes and closes an issue, please use the following in the commit message:
Closes #NN. Where NN is the issue number. This automatically closes it and links to it. Example:
git commit -m "Fixed recording issue with vga2usb on Fedora 17 Linux. Closes #721"
Send a pull request from your development branch (e.g. mybranch). While you wait for it to be pulled, you can start development for a different task on a new branch. For help, visit: http://help.github.com/send-pull-requests
Current in bold. Completed in strikethrough.