DevelopingMaui

Contributing to Maui

Proposing enhancements

Contact the project maintainer
if you have an idea for a contribution. Feel free to file a request for enhancement or clone the repository, add your changes and create a pull-request or patch set against the master branch. You should attach these patches to a ticket, describing your contribution.

Becoming a project member

If you plan to contribute more frequently, you may ask the project maintainer to join the project as a developer. This will give you write (push) access to the project's git repository. We recommend to create a branch for each new feature.

Contribution License Agreement

Please note that source code contributions must include the Maui License Header, stating that the submitted source code is licensed under either the terms of the L-GPL v3 Open Source license or the Eclipse Public License. Other licenses are not permitted for contribution, unless they have been explicitly conferred for the particular contribution by the project maintainer. Libraries using compatible licenses may be used as dependencies.

Development Environment

Maui is built on top of the NetBeans Rich Client Platform framework. We thus recommend to develop Maui using the latest NetBeans IDE version. Other IDEs can be used as well, but may offer a lower level of assistance.

Source Code Management

The source code of Maui is management by git. git is a distributed version control management system. Instructions on setting up git with NetBeans are available at the NetBeans Knowledgebase.

To check out the maui code as a developer with push rights, do

git clone ssh://SOURCEFORGEUSERNAME@git.code.sf.net/p/maltcmsui/code maltcmsui-code

A read-only clone of the codebase can be created with

git clone git://git.code.sf.net/p/maltcmsui/code maltcmsui-code

Next Steps

[BuildingMaui]