Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Plugin/Feature Configuration Guidelines"
| Line 1: | Line 1: | ||
This page describes the guidelines when creating new plugins for the EMFStore. | 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". | + | For the following settings we assume that we want to create a new plugin "test".<br> |
== General settings == | == General settings == | ||
| Line 15: | Line 15: | ||
*'''Provider:''' For the provider please enter "Eclipse Modeling Project". | *'''Provider:''' For the provider please enter "Eclipse Modeling Project". | ||
| + | |||
| + | <br> | ||
== Dependencies<br> == | == Dependencies<br> == | ||
| Line 21: | Line 23: | ||
*'''Internal plugins''' (plugins of emfstore) should not have any version matching settings. | *'''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). | + | *'''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. | + | *'''Reexport dependencies''' when they are used in other plugins depending on your plugin to reduce the maintaining efford.<br> |
| + | |||
| + | <br> | ||
| + | |||
| + | == Formatting & Checkstyle<br> == | ||
| + | |||
| + | For formatting & checkstyle configuration please refer to the "Getting Involved" page: [http://www.eclipse.org/emfstore/gettinginvolved.php www.eclipse.org/emfstore/gettinginvolved.php]<br> | ||
Revision as of 08:47, 28 June 2012
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 "JSE-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
For formatting & checkstyle configuration please refer to the "Getting Involved" page: www.eclipse.org/emfstore/gettinginvolved.php