How to contribute using GIT

The wxPython code is stored in a GitHub repository and the preferred way of providing changes is via PR's (Pull Requests), the following page will provide some pointers on how to work with git and Github.

The first thing you should do is create a free Github account and fork the wxWidgets/Phoenix repository (see top right of screen), see also Fork a repo. Then to get this code to your local PC you need to clone the fork you did, see also Git basics.

If you are planning on building the Phoenix binaries then you will also need the wxWidgets source. The correct version of the wxWidgets source is available as a git submodule in the Phoenix source tree, so if you run the following commands git will fetch a copy of the wxWidgets source for you:

You should repeat #3 once in a while (or perhaps everytime you pull down new changes) to make sure that you have the linked revision of wxWidgets in your workspace.

Create a pull request

A PR can be a simple one line change or a new widget or anything in between this. A pull request can be commented on and often the comment will mean changes to a PR before it will be merged, therefore it is strongly suggested to create a branch in your clone of the repo for each PR.

Following are the steps using the git cli and assumes you have ssh setup. I personally do this all in the UI client I use, until today that was Tortoise for GIT but Robin just mentioned SourceTree, which I have to say is much nicer and handles both git and hg repositories.

Resync your fork with Robin's master

After Robin has merged your change or done other changes to the master branch you need to get this into your fork.

Your fork is normally referred to as 'origin' and the wxWidgets repository is normally referred to as 'upstream' although you can use a different name for the remote repository if you wish.

You need to add the wxWidgets repo as a new remote (called upstream) in order to pull changes made by others into your repositories.


or SSH

Get the changes from upstream and push them to your fork.

Start with GIT

Git immersion tutorial -- This looks pretty comprehensive, just replace 'Ruby' with 'Python':)

Fork a repo -- This is what gave Robin the "Ah ha!" moment when trying to grok github.

git cheat sheet


Here are a few tips that may help make using git to make contributions to Phoenix a little less confusing while you are still getting the hang of it.

  1. Use a branch for all your changes. Always commit your changes to a branch that is not master, so your stuff doesn't get tangled up with changes coming from upstream or other repositories. This also makes it easier to push them to GitHub for PRs and it makes it easier to wipe them out if you decide it was a bad idea.

  2. Use separate braches for each logical grouping of changes (like each new feature or fix.)
  3. Never merge your local branches to the master branch. Always wait for your PRs to be merged and come back to you from upstream.
  4. If new changes on the master branch come from upstream while you are still working on a set of changes, and you would like to be able to work on your changes with those upstream commits in place, you can simply merge master into your branch. This also works okay if your branch has already been made into a PR.
  5. If you have more than one branch (besides master) that you would like to test all together, you can make a new branch and merge all the ones you want to test into that new one. If you need to make a change, switch back to the appropriate branch, make the change, commit it, and then merge that branch back into your combined testing branch again.

Graphical tools for GIT

Until today I used Tortoise for GIT and TortoiseHG, but had to check out Robin's favoured and find SourceTree very nice and it does handle both Github and Bitbucket repo's in one UI - neat:).

On Windows

SourceTree -- What Robin uses when he isn't using Git from the CLI.

Git for Windows

Tortoise for GIT - a graphical UI


SourceTree -- What Robin uses when he isn't using Git from the CLI.


GitX - a graphical UI

On Linux

"$@#!@! There's no SourceTree for Linux!" -- Robin

SmartGitHG -- It's not as smooth as SourceTree, but it is what Robin uses when he just can't figure out the CLI. Ironically, it's a NOT FREE tool that he only uses on a FREE operating system.

ContributeWithGIT (last edited 2015-04-08 23:28:11 by MoonKid)

NOTE: To edit pages in this wiki you must be a member of the TrustedEditorsGroup.