|Table of Contents|
How a non-committer should submit a patch to Project Wonder source that is easy and convenient for committers to apply.
- You have Wonder source checked out onto your system and imported into Eclipse workspace as per instructions at Working with Wonder source in Eclipse
- You have fully tested your changes
We have done a webcast about how to contribute to Project Wonder by using Git, you can get the recording here
Now that Project Wonder is hosted on GitHub, you can provide a patch in two different ways: by creating your own fork on Wonder, fix the code and create a Pull Request, or by doing the classical way of providing a patch file.
The Pull Request Way
This is way to go! Using pull requests on GitHub make it a lot easier to give feedback on contributions, and are more easier to track.
How can you create a pull request? Pull request is GitHub lingo for merging chances from two forks on the same code base. Basically, the steps are:
- If you don't already have one, you need to create a GitHub account
- You go on the Project Wonder page on GitHub and you click on the Fork button. This action will create a fork (copy) of the Wonder code in your account.
- Clone your fork on your computer. That will give you the chance to do contributions to Wonder in your own copy of the work.
- Do commits on your computer.
- When you are ready to make your work available, push your commits from your computer to your fork on GitHub.
- Create a pull request so your contributions can be added to the main fork of Wonder.
It might be a lot of steps, but really, you will find after a couple of days that it's a really good workflow!
The Patch File Way
Since the move to GitHub, the way of doing patches is different.
Now, you have to select Team -> Show History, and in the history, you will be able to right-click on the history and select Create Patch
Right-click the source file and select Team -> Create Patch...
Save the patch to a text file on your HD and click next
Leave the default setting as shown for the Advanced Options If you have a recent version of subversion, you can and should select Project relative patch root to be helpful and save the committers a few clicks.
If you want to file a patch for a .d2wmodel file, you should be using the latest version of RuleModeler and saving your rules in single rows to match the format of the rule files in Project Wonder. RuleModeler is not configured this way by default, so you will need to make the change in the preferences dialog. Check the option titled 'Save rules in single rows.'
Go to the Wonder BUG Tracker Online at
Use CREATE ISSUE and submit an issue. Please note that you can't attach files on issues on GitHub so you will need to put the patch file somewhere else (or a Git repo on GitHub!) and add a link to that file in the issue.