This document describes our standard Git development workflow and introduces the basics of how to work with Git and contribute to GitHub hosted projects by way of example. By the end you should be able to download and contribute to GitHub hosted project using the standard pull-request workflow.
- A GitHub account, sign-up at: https://github.com/signup/free
- Git command-line utility. Follow the instructions at: http://help.github.com/set-up-git-redirect
- Setup Git to rebase on all pulls by issuing the following at the command-line:
git config --global branch.autosetuprebase always
- Configure auto-correct line endings:
git config --global core.autocrlf input
- (optional) Configure your favorite text editor as the default for commit messages:
Unix: git config --global core.editor "nano"
- (optional) Configure a tool to handle merges
We should first identify the standard Subversion workflow you'll be familiar with so we can contrast it with Git.
- Checkout a project from the central SVN repository.
- Make modifications to the project as needed.
- Update the working copy to ensure the project is up-to-date.
- Commit the desired changes back to the central server.
This maps most directly to our use of Git and GitHub in the following way:
- Fork a Project to your GitHub account.
- Clone your fork of the project to your local machine.
- Make modifications as needed.
- Add the changes you want to commit to the “staging area”.
- Commit the staged changes to your local repository.
- Pull from the central server to ensure the project is up-to-date
- Push to your GitHub fork.
- Create a “pull request” to have your changes “pulled” into the main project.
The project you'll contribute to is located on GitHub at:
- Log into GitHub
- Go to: https://github.com/pentaho-nbaker/pentaho-cookbook
- Click the “Fork” button. When the process is completed you'll be redirected to your fork of the repository
- Copy the SSH URL from the horizontal control at top, e.g. email@example.com:...
- Open a command-line window.
- Navigate to a directory where you would like to clone your local copy to
- Execute the following to create a local clone of your fork. When done, you’ll have a full clone of the original repository:
git clone %URL%
- By default a special “remote” has been setup which points back to your GitHub fork. You'll also want to create a remote entry for the main repository. CD into your local clone and run:
git remote add upstream git://github.com/pentaho-nbaker/pentaho-cookbook.git
- Make some modification to the project, add some CSS, contribute a new recipe, etc.
- To add a new recipe copy recipes/rhubarb-pie.js into recipes/newRecipe.js and modify.
- Update index.html to include your new recipe script (just below the existing rhubarb-pie.js reference)
- Next you need to “add” the modified or new files to the commit staging area:
git add index.html recipes/newRecipe.js
- Now commit these staged changes:
git commit -m "New Recipe and style changes"
- To get your commit (changeset) incorporated back into the main repository, you need to push it back to GitHub. However, before you do you should "pull" down from the "upstream" remote to ensure you're up-to-date with the latest changes
git pull upstream master
- (Optional) You may have to merge your changes with those from the server. Follow instructions here on how to get your “mergetool” setup http://www.gitguys.com/topics/merging-with-a-gui/.
- For each conflicted file use the mergetool: git mergetool index.html.
- Call git add for each conflicted file which you’ve resolved:
e.g. git add index.html
- Commit the added files to finish the merge operation:
git commit -m "My merge of foo"
- Now that you're sure to be up-to-date, push your changes up to your GitHub fork:
- Open a browser to your fork of the repository.
- Click the "Pull Request" button and follow the prompts.
- Sit back and relax! You’ve made it through.
Official Man pages for the commands:
Bash command completion: