Developers

HOME > DEVELOPERS

This section provides detailed information about the *FRaMED* editor, its structure and the used technologies and frameworks. In order to understand how *FRaMED* works we advice you to get familiar with ORM, EMF and GEF. The setup guide helps you with the first steps of compiling and running *FRaMED* from within Eclipse IDE.

Introduction

The Beginners Introduction page contains useful links for understanding FRaMED's architecture. Under Architecture, a more detailed explanation of FRaMED's components can be found.

Setup Guide

Setting up the Eclipse IDE for the development of FRaMED is quite easy, although there are some points you have to take care of. Our Setup Guide will help experienced developers, whereas the Step by Step Installation will help novice programmers to get everything right.

Release

A release of a new version consists of several steps you'll need to take. If applicable, merge the develop or feature branch into master. For instance, if the code for a release v1.1.0 is on a branch named develop you'll need to issue the follow commands (assuming your local version of develop is up-to-date):

git checkout master
git merge develop
git push

This will merge the changes from develop into master and push it back the remote. That way, you can check the Travis-CI build before issueing the release.

git tag -a v1.1.0 -m "release v1.1.0" master
git push --tags

This will create a tag for the release so that it can be found easily in the history.

Note: Make sure to get all the versions right! That means that you have to:

• develop: set all versions to release version and commit, e.g., 1.1.0.qualifier -> 1.1.0
• master : merge develop into master; the version is already correct
• develop: prepare all versions for the next release, e.g., 1.1.0 -> 1.2.0.qualifier

Code Style

The Java source code should adhere to the Google Java Style Guide. An Eclipse formatter configuration conforming to the style guide can be found under codestyle/framed-java-formatter.xml.