Making a contribution

Jump to bottom Edit New page

jimburton edited this page Jul 3, 2013 · 2 revisions

First, familiarise yourself with the basics of git. To make a contribution to the project you need to carry out the following steps:

Create a github account and fork the repository on github.
Clone your new repository onto your local machine:

    $ git clone url_of_new_fork
    $ cd BigArrow

You need to keep the master branch of your new repository clean, i.e. identical to the current state of the original repository. So, each time that you want commit a bug fix or new feature you need to create a branch for it. So, make a new branch, push it github and start working in the new branch.

    $ git branch name_of_your_new_branch
    $ git push origin name_of_your_new_branch
    $ git checkout name_of_your_new_branch

You can have lots of branches and when you submit a pull request in one branch there is nothing to stop you continuing work in a separate branch.

Create a pull request to ask that your changes be pulled into the main repository.