Contributing

To help out with this project you will need to,

  1. clone the Github repository to your computer.

  2. Follow through Compiling the Code and make sure it works locally

  3. Create a branch on your computer & publish this branch to your Github account. Using GitHub Desktop makes this easy.

    Always work in a branch not master. If you intend to create a pull request it will go smoothly

  4. When your happy with your commits push them to your Github account.

  5. Create a pull request on GitHub, details of what the changes are in the note so it can be tested.

There are lots of good Git tutorials out there, it can be overwhelming at first as it's a powerful tool. Suggest watching a few videos before diving in.

Last updated