Skip to content

Commit 11e4106

Browse files
committed
Add contribution instructions
1 parent 4a516dd commit 11e4106

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For everything else you need to know, you can find the information on our own su
3535

3636
MOST IMPORTANTLY, have fun :)
3737

38-
Contributers/Developers
38+
Developers
3939
===============
4040

4141
###Current Team
@@ -61,6 +61,22 @@ Contributers/Developers
6161
All contributors can be found _[here](https://github.com/TPPI-Dev/TestPackPleaseIgnore/graphs/contributors)_.
6262

6363

64+
Contributing
65+
===
66+
We love getting outside contributions, especially to our mod documentation system, however doing so can be a little complex for some.
67+
68+
First a note: If you are going to contribute, please make your contributions to the ___Dev___ branch, not master. Switch this by using the dropdown box on the main repo page.
69+
70+
Also, if you are just planning on making a one-line change, or anything that just alters one file, you can simply find the file and press "edit", and github will do the rest.
71+
72+
To make any larger contributions, it is recommended to have [Github for Windows/Mac/Linux](https://help.github.com/articles/set-up-git) installed (use the orange button for the application, or the rest of the article for command line git).
73+
74+
To do so you will need to make what is called a "fork" of this repository. To do this press the "Fork" button on the top right of the page, and github will create your own copy of this repository. Once that has completed, use the github application to "clone" this repository, [Github Help](http://help.github.com) can help you with this portion. Make the changes on your computer, then commit and push those back to your fork (again, refer to the github help documents).
75+
76+
Once your fork has all the changes you want, you need to create a "pull request" on the main repository. To do this, go to the pull request tab on the right, and hit "new pull request". At the top of that screen hit "compare across forks", then choose the second dropdown on the first line to be "Dev", the first dropdown on the second line to be _your_ fork, and the final dropdown to be "Dev" again (This may require hitting "compare across forks" and "edit" quite a few times to get it right). If everything looks right, meaning you see all your commits on the screen, hit "Create pull request" and we will review it as soon as possible.
77+
78+
Thank you for your help!
79+
6480
Current Modlist
6581
===============
6682
Google Doc. Modlist: http://bit.ly/TPPI-Modlist

0 commit comments

Comments
 (0)