Contribute developer guide

How you can help

UML Designer is an open source project and everyone is encouraged to get involved! There are lots of ways you can contribute:

Get the source code

This UML modeling environment is based on the Sirius. It is under an
Open Source license (EPL) and the source code is hosted on github.
It is intended to cover most use cases behind the usage of UML, and more importantly to be reused when you apply a
model driven approach which uses both UML and some DSL. Everything should integrate seamlessly in the same environment.

To get the code just clone the repository :

Contribute

Contribute to the code

UML Designer’s code is hosted on Github. It’s easy to get the code and build UML Designer from source. Just clone our repository, make your changes, adapt it to your need and trigger a pull request.

Contribute to the documentation

Found an error in this web-site or in the documentation? Please help us and contribute.
UML Designer’s documentation is hosted on Github: https://github.com/ObeoNetwork/UML-Designer/tree/master/documentation. Just clone our repository, update the documentation and trigger a pull request. The documentation is written with the textile syntax, so it is really easy to contribute. Have a look to the Documentation section in the developer guide to learn more about how we build the UML Designer documentation.

Providing Feedback

We’re constantly looking for feedback about this modeler, if you think something is missing, some behavior is weird or even just to tell us you are happy with it in its current state, please come and exchange.

Report bugs

Bug reports are really important, so please report any issues you have. When you report bugs, make sure you include lots of detail, reproducible tests, example code or anything else you think might help!

The bug tracker is available on github : https://github.com/ObeoNetwork/UML-Designer/issues.
We are using the github integrated issue tracker.

To enter a new issue you just need to create a github account.

To search for issues, have a look to the github help page to learn the searching issue syntax.

You can visualize also on which issues we are working on thanks to our card wall: https://waffle.io/obeonetwork/uml-designer

Forum

If you have any question, do not hesitate ask a question on Stack Overflow. When you ask a question do not forget to add the tag uml-designer.

Survey

Give us feedback by filling in our survey!

Get the developer environment

An Oomph setup is provided to ease the installation of the developer environment : UMLDesigner.setup

1. Download the Oomph installer and launch it.
2. Switch to the Advanced mode, and make sure your settings are ok for Github (your key is registered at Github).
3. Select Eclipse.org → Eclipse Platform and click on Next.
4. Add the UML Designer setup file (either download it and choose it via the file browser or copy this link into URI field). Select the UMLDesigner AND double-click on it to be sure that it is listed in projects listing on the bottom. Then click Next. Then select where you want to install the UML Designer development environment.
5. When the installation is finished, you need to activate manually the target platform to use : releng/org.obeonetwork.dsl.uml2.target. We use target-platforms to define explicitly plugins and features available in the build context. The same are also used to work on UML Designer in our Eclipse IDE.
6. Let’s go contributing to UML Designer!