Assembla home | Assembla project page
 

A quick outline of how to contribute code to OpenAustralia:

Setting up

1. Follow the install directions and get the web application and parser up and running

2. Tell git your name and email address with:

git config --global user.name "Your Name Comes Here"
git config --global user.email you@yourdomain.example.com

3. Go to github.com and sign up for an account

4. Fork the following repositories:

Go to each repository with the links and click on the "fork" button.

If you plan to modify the perlib, phplib, rblib or shlib libraries as well (fairly unlikely) then you will need to fork these as well:

5. Upload your public SSH key to github. You will need this to be able to push changes to your forked repositories. See http://github.com/guides/providing-your-ssh-key

6. Tell git how to push changes to your repository on github

$ cd openaustralia-parser
$ git remote add github git@github.com:<your username>/openaustralia-parser.git 
$ cd ../twfy
$ git remote add github git@github.com:<your username>/twfy.git

Everything interesting happens here

1. Make your changes and commit them

2. Once you are happy to publish the changes, push them to your forked repository on github

$ cd openaustralia-parser
$ git push github

3. Go to github.com and let Matthew know to merge your changes. Do this by clicking on "Pull Request" on your forked repository page on github

That's it!