@@ -30,34 +30,54 @@ Please clean up any messes that you find, and don't leave behind new messes for
3030Idris developers and hackers try to adhere to something similar to the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/).
3131The steps are straightforward.
3232
33+### New contributors
34+
3335For those new to the project:
3436
35−1. Fork the `idris-dev` repo e.g.
37+1. Fork our [main development repository](https://github.com/idris-lang/Idris-dev) `idris-dev` on github e.g.
38+2. Clone your fork to your local machine:
39+
40+```
41+$ git clone git@github.com/<your github user name>/Idris-dev.git
42+```
43+
44+3. Add `idris-lang/Idris-dev` as a remote upstream
3645
37− $ git clone git@github.com/<your github user name>/Idris-dev.git
38− $ git remote add upstream git@github.com:idris-lang/Idris-dev.git
46+```
47+$ git remote add upstream git@github.com:idris-lang/Idris-dev.git
48+```
49+
50+### Existing Contributors
3951
4052For those already contributing to the project:
4153
42−1. Ensure your existing clone is up-to-date with current HEAD e.g.
54+1. Ensure your existing clone is up-to-date with current `HEAD` e.g.
55+
56+```
57+$ git fetch upstream
58+$ git merge upstream/master
59+```
4360
44− $ git fetch upstream
45− $ git merge upstream/master
61+### Remaining Steps
4662
47−The remaining steps are the same:
63+The remaining steps are the same for both new and existing contributors:
4864
49651. Create, and checkout onto, a topic branch on which to base you work.
5066 * This is typically the master branch.
5167 * For your own sanity, please avoid working on the `master` branch.
5268
53− $ git branch fix/master/my_contrib master
54− $ git checkout fix/master/my_contrib
69+```
70+$ git branch fix/master/my_contrib master
71+$ git checkout fix/master/my_contrib
72+```
5573
56741. Make commits of logical units.
57751. Check for unnecessary whitespace with
5876
59− $ git diff --check
60−
77+```
78+$ git diff --check
79+```
80+
61811. Make sure your commit messages are along the lines of:
6282
6383 Short (50 chars or less) summary of changes
@@ -79,11 +99,15 @@ The remaining steps are the same:
79991. Make sure you have added any necessary tests for your changes.
801001. Run all the tests to assure nothing else was accidentally broken.
81101
82− $ make test
102+```
103+$ make test
104+```
83105
841061. Push your changes to a topic branch in your fork of the repository.
85107
86− $ git push origin fix/master/my_contrib
108+```
109+$ git push origin fix/master/my_contrib
110+```
87111
881121. Go to GitHub and submit a pull request to `idris-dev`
89113