Collaboration Guide

Contributing to the project is simple!

Steps

1. Get your personal "forked" copy.
2. Make changes.
3. Request a merge with the original project.
4. Update GDocs with any relevant changes.

Details

Get your personal "forked" copy:

1. Install 'GitHub for Windows' from http://windows.github.com ("the app").
2. On this webpage, click "Fork" button at top-right to create your personal copy of this project. You should be on your forked version of the project webpage.
3. Click "Clone in Windows".

Make changes:

1. Open the project in the app.
2. Select the branch you wish to work on (see "branches" below).
3. Improve the project with your preferred editors like ModBuddy and Notepad++.
4. Note your changes on the issues page.
5. Commit each change in the app, with a brief description of what you did.
6. Click the "sync" button in the github app.

Request a merge with the original project:

1. Open the github app app.
2. Open your forked project webpage.
3. Click the "pull request" button.
4. Write your pull request.
5. A project leader will merge your changes into the root project as soon as possible.

See tutorial here if you need more help: https://help.github.com/articles/using-pull-requests

If you encounter a problem while syncing or merging your project, open a shell and type "git status". This should show you the problem and some basic instructions to solve it. See the page "resolving a merge conflict" for more information.

Branches

The project has two main branches: "stable" and "new-features".

• To fix a bug, change to the branch with the issue and fix it directly.

• For small features that require less than a day's work to complete, work in the "new-features" branch.

• Create a new branch for features that will take more than a day. Name the branch something descriptive like "wonders" and do all your work there. When done with the feature, merge the old branch with the "new-features" branch, and unpublish the old branch.

Code Writing Style