MoDisco/How to contribute

From Eclipsepedia

Jump to: navigation, search

The MoDisco project is open to contributors. All external contributions are welcome :

  • new modernization use-cases
  • extensions of MoDisco components
  • metamodels of legacy technologies
  • discoverers and model transformations

Contents

How To contribute

In the comments of your code, you may mention your identity and company by mail, URL, etc. In this way you may get back some advice from interested people.

To submit your MoDisco contribution, please open a bugzilla entry in the Modeling/GMT/MoDisco component (you can use the following address: https://bugs.eclipse.org/bugs/enter_bug.cgi?product=GMT&component=MoDisco-Contribution ). Then you could attach your file(s).

Your contribution will be reviewed and integrated.

If you need more details, please use the MoDisco newsgroup.

What to do before contributing

If you wish to publish your component(s) in this project, please check following points :

  • Provide an about.html file (Cf. http://wiki.eclipse.org/The_about.html)
  • Provide your Code with the header described below
  • Check unused plug-in dependences
  • Check that it exists one branding plug-in per feature
  • Externalize String from code

The following Bash command can be used to search missing about.html files:

 $ find org.eclipse.gmt* -name build.properties \! -exec grep -sq about.html {} \; -type f -print

Header Syntax

 /**
 * *******************************************************************************
 * Copyright (c) <year> <company>.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     <contributor> (<company>) - initial implementation
 * *******************************************************************************
 *
 * $Id$
 */

Manifest file

In the MANIFEST.MF:

  • the vendor name must be "Eclipse Modeling Project"
  • the plug-in name must finished with "(Incubation)"
  • the plug-in version must finish with ".qualifier"

In the MANIFEST.MF the Strings must be externalized (use “PDE Tools > Externalize Strings…”)

String Externalize

Select the project, then usr "Source > Externalize Strings...". A wizard shows strings to internationalize or not.

Beware of not using concatenations in messages, since each language might have a different order. For instance, rather than :

       MoDiscoBrowserPlugin.logError("Condition query " + queryName + " in query set "
               + querySetName + " : expected boolean return type, got "
               + conditionResult.getClass().getSimpleName() + ".");

We will prefer to have:

in messages.properties :

       CustomizationEngine_conditionQueryWrongReturnType=Condition query {0} in query set {1} : expected boolean return type, got {2}.

in source :

       MoDiscoBrowserPlugin.logError(NLS.bind(
               Messages.CustomizationEngine_conditionQueryWrongReturnType,
               new Object[] { queryName, querySetName,
                       conditionResult.getClass().getSimpleName() }));

Moreover, Eclipse recognizes Bundles Messages and displays the string content when mouse pointer is on a key in the source. And in doing "Source > Find Broken Internationalized String", we may find the keys undefined or ununsed.

You may activate the strings verification in Eclipse preferences : Windows > Preference > Java > Compiler > Erros/Warnings > "Non-externalized strings (missing/unused $NON-NLS$ tag"

Version numbering

Guidelines of MoDisco components are available here

build.properties

Following files and folders should never been in “src.includes” (see bug 286808):

  • .classpath
  • .project
  • .settings/
  • META-INF
  • OSGI-INF/
  • bin/
  • build.properties
  • plugin.xml
  • plugin.properties
  • src

When a file is in bin.includes, it should never be present in src.includes, with the exception of about.html.

Get the source of MoDisco project

Svn Howto