Revision as of 13:53, 14 August 2014

Eclipse projects must carefully manage their namespaces in order to help identify the producer of components and avoid namespace collisions.

Some of the content here is presented in the form of guidelines ("should"), and some in the form of rules ("must"). In general, it's about being a good citizen and playing well with others. We believe/hope that exceptions to the rules are rare; exceptions to rules must be approved by the Project Management Committee and the EMO.

Java Package Names

Java package naming conventions are well-established and so Java package names must take the standard reverse DNS form:

org.<forge>.<shortname>.<component>.*

Where:

• forge is the short name of the hosting forge, e.g. "eclipse", "locationtech", or "polarsys";
• shortname is the short name of the project (i.e. the last segment of the project id), e.g. "dali", "egit", "udig"; and
• component is project-specific

Multiple component segments are permitted.

Examples:

• org.eclipse.emf.core, org.eclipse.emf.edit, org.eclipse.emf.edit.ui; and
• org.locationtech.udig.resources

Java package names use the "flat" or "short" project name in the third segment; they should not include, for example, the name of the top-level project or any parent/container project.

• e.g. org.eclipse.graphiti.core, not org.eclipse.modeling.mdt.graphiti.core or org.eclipse.mdt.graphiti.core.

Scala Package Names

TBD

OSGi Bundle Names

OSGi Bundle names must follow the same rules as Java Package Names.

Maven

Maven Group Ids

This is a work in progress.

The Maven group id must follow the standard reverse DNS naming convention:

org.<forge>

Where:

• forge is the short name of the hosting forge, e.g. "eclipse", "locationtech", or "polarsys";

Examples:

• org.eclipse
• org.locationtech
• org.polarsys

For discussion, please see [1].

Maven Artifacts

Maven Versions

Java Archive (JAR/WAR/EAR) Names

TBD

JavaScript

TBD

This page is moderated by the EMO.