|
Size: 2842
Comment:
|
Size: 2841
Comment: typo
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| The wxPython code is stored in a Github repository and the preferred way of provinding changes is via PR's (Pull Requests), the following page will provide some pointers on how to work with git and Github. | 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. |
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 a free Github account and fork Robin's repo (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.
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.
git checkout master - switch to the master branch
git checkout -b yourbranchname - create 'yourbranchname' and check it out, sometimes called switch to it
make changes and git commit -a -m 'add your first change' - do this frequently
git push
- create the PR on your github account from 'yourgitaccount:yourbranchname' to 'robinD42:master'
- getting comments to the PR
- make changes and commit frequently
git push the PR will be updated automatically
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 Robin's master is normally referred to as 'upstream'.
You need to add Robin's repo as upstream.
- git remote add upstream git@github.com:RobinD42/Phoenix.git
Get the changes from upstream and push them to your fork.
git fetch upstream
git checkout master
git rebase upstream/master
git push
A few links to tutorials and other useful help to get going with git.
Git immersion tutorial This looks pretty comprehensive, just replace 'Ruby' with 'Python':)
Graphical tools for GIT
On Windows
Tortoise for GIT - a graphical UI
On MAC