As a summary the best practice for contributing is to:
- Fork it
- Clone it to your local system
- Make a new branch
- Make your changes
- Push it back to your repo
- Click the Compare & pull request button
- Click Create pull request to open a new pull request
You will need a github account to contribute. It is assumed you have one and that you have familiarity with git. If you need some reminding then please read through the maintaining guide first. It will run through editing files all the way to committing them.
In this example (for a different git repo) click on the Fork button to make a copy to your git hub account
git clone link - the 'link' to your accounts fork of this repo
Inspect it on your system
git checkout -b newbranch - creates a new branch called newbranch (you can call it anything you like)
Using a text editor (eg. notepadd++) or IDE (eg. pycharm)
git add * - add the changes to the header
git commit -m "a message" - make a commit statement
git checkout master - working on the master branch again
git merge newbranch - merge the change on the newbranch to the master
git push - push the changes back to orginal
Navigate back to this repo and click on big green button marked "Compare and pull request".
Now you will be able to (and ideally should) write a note about your pull request. It will also show you the changes you have made.
Review your changes and when you are happy then click the green "Create pull request" button. Now wait for an admin of this repo to respond. They may seek further information before merging.
For a indepth guide to editing and git commands related to this repo please visit maintaining.md. This maybe helpful if you are unfamiliar with git desktop or git command line. The guide also contains links to more detailed documentation