View source for Tutorial:Contributing Code

PMDO is open source with the MIT license.  It means that anyone is allowed to use, redistribute, and modify the software among other things.  When you push to github you provide code under the same license.

To contribute to PMDO, you will need to create a Pull Request of your code.  In order to do that, you need to push a branch to a fork of the original repo.  And in order to do that, you need to have a branch, and have a fork.

First, let's create our own branch.  If you have already made edits to PMDO on your local copy by following the [[Debugging_PMDO| Debugging tutorial]], you will need to create a new branch of your work and commit to it.
<pre>
git checkout -b my_branch
git add .
git commit -m"commit message"
</pre>

Then, you will need to fork the repo you are making changes to from github's UI:

[[File:PR_Create_Fork.png|frameless]]

In this case, we are forking RogueEssence, but if your changes have affected other repos such as PMDODump or PMDC, you will need to fork them separately as well.

You now have a fork of the repo under your account- in other words, a new remote.  You need to add this remote as a part of your git setup.

<pre>
git remote add my_remote_name https://github.com/my_user_name/RogueEssence.git
</pre>

Then push your branch to this repo.

<pre>
git push my_remote_name
</pre>

It should now appear as a branch in your repository.

[[File:PR_Branch.png|frameless]]

Next, create a pull request from this branch.  Github makes it easy with a single button:

[[File:PR_Create_PullRequest.png|frameless]]

You will be taken to a UI where you can compare your branch's difference with the original repo, as well as add comments on what you changed.

[[File:PR_Comparing.png|frameless]]

The pull request is now added. Now you will just need to wait until the code gets reviewed, and the branch will either be merged into the main repo or you will be asked for changes.

[[File:PR_Create_Complete.png|frameless]]

[[Category: Engine]]