Skip to content

Instantly share code, notes, and snippets.

@beppu

beppu/git-workflow-for-webgui.md

Created August 15, 2014 01:05
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save beppu/c124903b78fb4d1fcd12 to your computer and use it in GitHub Desktop.
Save beppu/c124903b78fb4d1fcd12 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
git-workflow-for-webgui.md

Using Git to Contribute to WebGUI 8

For those of you want to contribute to the development of WebGUI 8, here are a few tips to help you get started.

First, fork AlliumCepa/webgui.

This will create a fork of webgui owned by your github account.

export user=you

Next, clone the repository you just forked.

git clone git@github.com:$user/webgui.git

Then, add AlliumCepa/webgui as a remote.

git remote add upstream https://github.com/alliumcepa/webgui.git
git fetch upstream

At this point, you have your own fork of webgui along with a copy of the development fork, AlliumCepa/webgui.

Keeping Track of Upstream Changes

To keep track of what's happening upstream, you should periodically do this:

git fetch upstream
git merge upstream/master

It's especially important to do this before you send us a pull request, because it makes it easier for upstream to merge your work in.

Making Contributions

If you're making small changes, do it in your master branch.

git checkout master

If you're making larger changes, create a branch off of your master.

git checkout -b big-feature master

Once you're in the right branch, edit the code and commit your changes. When you think your work is ready to be merged back into AlliumCepa/webgui, send us a pull request.

More Info

To learn more about using git and github, I recommend the following:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment