There are many ways you can help make UFace a better piece of software - please dive in and help. We love contributions!

Try surf the wiki - if somethings confusing or not clear, let us know. Download the code & try it out and see what you think. Browse the source code. Got an itch to scratch, want to fix some issue or add some feature? Go for it!

Want to do some hacking on UFace? Try surfing the our issue tracker for open issues or features that need to be implemented, take ownership of an issue and try fix it.

Getting in touch

There are various ways of communicating with the UFace community.

• join us on the discussion group and take part in any conversations
• raise an issue in the issue tracker
• pop by on IRC and say hi
• add some comments to the wiki

If you find a bug or problem

Please raise a new issue in our issue tracker

If you can create a JUnit test case then your issue is more likely to be resolved quicker. Then we can add your issue to Subversion and then we'll know when its really fixed and we can ensure that the problem stays fixed in future releases.

Adding attributions for your work

Advertise yourself. When fixing an issue you should add yourself to the Contribution-Section found at the top of each class-file you modified.

/*******************************************************************************
 * Copyright (c) 2007, Original authors.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     James Strachan <james.strachan@iona.com>
 *     Tom Schindl <tom.schindl@bestsolution.at>
 *     $YOUR_NAME <$YOUR_EMAIL> - bugfix for issue: $x
 *******************************************************************************/

Creating patches

We gladly accept patches if you can find ways to improve, tune or fix UFace in some way.

Most IDEs can create nice patches now very easily. e.g. in Eclipse just right click on a file/directory and select Team \-> Create Patch. Then just save the patch as a file and then submit it. (You may have to click on Team \-> Share... first to enable the Subversion options). Incidentally if you are an Eclipse user you should install the subclips plugin.

If you're a command line person try the following to create the patch

diff -u Main.java.orig Main.java >> patchfile.txt

or

svn diff Main.java >> patchfile.txt

The easiest way to submit a patch is to create a new issue, attach the patch, tick the Patch Attached button on the issue then fire off an email to the discussion group.

Licensing of your contribution

All contribution made to UFace have to be made under EPL. This ensures that your code can be used as easy as possible by consumers of the UFace-Library.

Becoming a committer

The first step is contributing to the project; if you want to take that a step forward and become a fellow committer on the project then we ask that you agree to the CommitterAgreement on the discussion group then we can grant you the necessary karm. The committer agreement is similar to agreements on Eclipse and Apache projects; its to protect the contributor and the project -so that there's no IP or copyright issues for developers and users of the project.