Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Plugin/Feature Configuration Guidelines

This page describes the guidelines when creating new plugins for the EMFStore.

For the following settings we assume that we want to create a new plugin "test".

General settings

These settings can be modified in the "New Plug-in Project" wizard.

  • Namespace: The plugin-name should begin with "org.eclipse.emf.emfstore". Therefore the name of our test plugin and the prefix for the packages would be "org.eclipse.emf.emfstore.test".
  • Execution Environment: As JRE version the plugin should use 1.5, so please select "J2SE-1.5".
  • Version: As version please use the current version (see in other plugin) plus the qualifier, e.g. "0.9.0.qualifier".
  • Name: Enter a describing name for your plugin plus "(Incubation)", e.g. "Cool Test Plugin (Incubation)".
  • Provider: For the provider please enter "Eclipse Modeling Project".

Dependencies

When adding dependencies to your project please note the following giudelines:

  • Internal plugins (plugins of emfstore) should not have any version matching settings.
  • External plugins should have the needed minimum version and the next major version as maximum version, e.g. "[4.8.1, 5.0.0)".
  • Reexport dependencies when they are used in other plugins depending on your plugin to reduce the maintaining efford.

Formatting & Checkstyle

Please activate checkstyle with the emfstoreStyle and activate the Emfstore formatter for your plugin. For formatting & checkstyle configuration please refer to the "Getting Involved" page: www.eclipse.org/emfstore/gettinginvolved.php

Back to the top