|
|
| Line 1: |
Line 1: |
| − | Eclipse projects must carefully manage their namespaces in order to help identify the producer of components and avoid namespace collisions.
| + | The EMO has moved this content to the [http://localhost/projects/handbook/#trademarks-code Eclipse Project Handbook]. |
| − | | + | |
| − | 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.
| + | |
| − | | + | |
| − | =Languages=
| + | |
| − | ==Java Package Names==
| + | |
| − | | + | |
| − | Java package naming conventions are well-established and so Java package names '''must''' take the standard [http://en.wikipedia.org/wiki/Reverse-DNS reverse DNS] form:
| + | |
| − | org.<forge>.<shortname>.<component>.*
| + | |
| − | Where:
| + | |
| − | * ''forge'' is the short name of the hosting [[Forges|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:
| + | |
| − | * <code>org.eclipse.emf.core</code>, <code>org.eclipse.emf.edit</code>, <code>org.eclipse.emf.edit.ui</code>; and
| + | |
| − | * <code>org.locationtech.udig.resources</code>
| + | |
| − | | + | |
| − | 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. <code>org.eclipse.graphiti.core</code>, not <strike><code>org.eclipse.modeling.mdt.graphiti.core</code></strike> or <strike><code>org.eclipse.mdt.graphiti.core</code></strike>.
| + | |
| − | | + | |
| − | ==Scala Package Names==
| + | |
| − | | + | |
| − | TBD
| + | |
| − | | + | |
| − | =Packaging/Distribution=
| + | |
| − | ==Features==
| + | |
| − | | + | |
| − | The feature name should be descriptive of the feature. There is no need to include the project name in the feature name. Think of a descriptive name that is useful to the end user/consumer.
| + | |
| − | | + | |
| − | The provider name should be the full project name. If the name does not already do so, then prefix it with the name of the forge, e.g. "Eclipse EGit", "Eclipse SWTBot", or "LocationTech uDig".
| + | |
| − | | + | |
| − | ==OSGi Bundle Names==
| + | |
| − | | + | |
| − | OSGi Bundle names '''must''' follow the same rules as [[#Java Package Names|Java Package Names]].
| + | |
| − | | + | |
| − | The Bundle-Vendor should be the full project name. If the name does not already do so, then prefix it with the name of the forge, e.g. "Eclipse EGit", "Eclipse SWTBot", or "LocationTech uDig".
| + | |
| − | | + | |
| − | ==Maven Repositories==
| + | |
| − | {{Warning|This is a work in progress.}}
| + | |
| − | These guidelines/rules apply primarily for Eclipse Foundation-hosted Maven repositories. We believe that it is in the best interests of the broader community to consistently apply these guidelines/rules outside of that scope as well.
| + | |
| − | | + | |
| − | ===Maven Group Ids===
| + | |
| − | Per [http://maven.apache.org/guides/mini/guide-naming-conventions.html Maven naming conventions], the Maven group id '''must''' follow the standard reverse DNS naming convention:
| + | |
| − | org.<forge>.<short-name>
| + | |
| − | Use of more specific group ids is also possible:
| + | |
| − | org.<forge>.<short-name>.<component>.*
| + | |
| − | Where:
| + | |
| − | * ''forge'' is the short name of the hosting [[Forges|forge]], e.g. "eclipse", "locationtech", or "polarsys";
| + | |
| − | * ''short-name'' is the short name of the project (the name used in IPZilla, and the in project information pages]
| + | |
| − | * ''component'' is project-specific
| + | |
| − | Examples:
| + | |
| − | * <code>org.eclipse.egit</code>, <code>org.eclipse.birt</code>
| + | |
| − | * <code>org.locationtech.udig</code>, <code>org.locationtech.geomesa</code>
| + | |
| − | * <code>org.polarsys.reqcycle</code>, <code>org.polarsys.cotsaq</code>
| + | |
| − | | + | |
| − | For discussion, please see [https://bugs.locationtech.org/bugs/show_bug.cgi?id=28].
| + | |
| − | | + | |
| − | ===Maven Artifacts===
| + | |
| − | | + | |
| − | ===Maven Versions===
| + | |
| − | | + | |
| − | ==Java Archive (JAR/WAR/EAR) Names==
| + | |
| − | | + | |
| − | TBD
| + | |
| − | | + | |
| − | <hr/>
| + | |
| − | ''This page is moderated by the EMO.''
| + | |
