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.
Difference between revisions of "Development Resources/HOWTO/Project Naming Policy"
(→Project Naming Policy) |
(→Newsgroup.) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===Project Naming Policy=== | ===Project Naming Policy=== | ||
| − | Naming and branding are challenging issues. The Eclipse brand is important | + | Naming and branding are challenging issues. The Eclipse brand is important. To help provide a consistent brand for Eclipse, projects are instructed follow these project naming guidelines. The best names are descriptive but at the same time memorable. |
The policy for project names is: | The policy for project names is: | ||
| − | * | + | * '''Descriptive Name''' Projects are encouraged to use a descriptive name - a name that is useful when placed into a box on an Eclipse architecture diagram. For example "[http://www.eclipse.org/gmf Graphical Modeling Framework]", "Trust Framework" or "Component Assembly Tools". |
| − | ** | + | ** Descriptive names do not tend to include the words "Eclipse" or "Project". The project name should work with or without the prefix and/or suffix. For example, "Graphical Modeling Framework", "Eclipse Graphical Modeling Framework", "Graphical Modeling Framework Project", and "Eclipse Graphical Modeling Framework Project" are equally understandable. |
| − | ** | + | ** Descriptive names may optionally include the words "Framework" or "Tools" if the project has more of an emphasis on extensible frameworks, or more on exemplary tools. Eclipse projects always provide both but may be tailored more toward one or the other. When choosing to use these words, the team should consider that "Framework" and "Tools" mean different things to different people and may even be ecoming overused. |
| − | ** | + | ** Top-level projects may optionally include the word "Platform" instead of "Framework". Or not. |
| − | * | + | * '''Short Name''' Projects require a short name; this name is used to represent the project in the Eclipse Foundation database, and it |
| − | * | + | ** The short name may contain lowercase alphanumeric characters, dashes, and underlines. The short name may not contain periods (.) |
| − | * | + | ** The short name is joined with the short name of the parent project(s) to form a qualified identifier for the project that is used as a key on many of the webpages and services generated and/or maintained for your project by the Eclipse Foundation. e.g. Project "Woolsey" has a short name of "woolsey"; it's qualified name is "technology.dash.woolsey", indicating that it is a subproject of the "Dash" project which is itself a subproject of "Technology". |
| + | * '''Nicknames.''' If a team strongly prefers to use a nickname style project name, instead of a purely descriptive project name, there should also be a longer "more official, but less often used" (MOLU) combination nickname-descriptive project name. For example, the "Higgins" project has a MOLU name of "The Higgins Trust Framework". | ||
| + | * '''Acronym.''' Most descriptive names are sufficiently long that it can be convenient to abbreviate them in some way. For example, the Eclipse Communication Framework shortens to ECF. | ||
| + | * '''Not a Product Name.''' To avoid confusion between Eclipse projects and commercial products, Eclipse projects may not be named after commercial products and vice versa. | ||
| + | |||
| + | As a defensive measure, the Eclipse Foundation holds the trademark to the Project names on behalf of the Projects - this prevents companies from misusing or misrepresenting their products as being the Projects.) The EMO will initiate a trademark review prior to scheduling a [[Development Resources/HOWTO/Creation Reviews|Creation Review]]. Existing trademarks must be transfered to the Eclipse Foundation (please see the [http://www.eclipse.org/legal/Trademark_Transfer_Agreement.pdf Trademark Transfer Agreement]). | ||
===Using the Project Name=== | ===Using the Project Name=== | ||
| − | |||
Every public use of the project name - in a web page, a presentation, a press release, an article, etc. - should follow these guidelines: | Every public use of the project name - in a web page, a presentation, a press release, an article, etc. - should follow these guidelines: | ||
| − | * The first use of the Project Name uses the entire Descriptive Name | + | * The first use of the Project Name uses the entire Descriptive Name and may include the optional Nickname. For example, "The Eclipse Component Assembly Project (Buckminister)". Subsequent references to the project may use the Nickname, e.g., "Buckminister". |
| − | * If the project is in the Proposal Phase, or is a Technology Project, that fact | + | * If the project is in the Proposal Phase, or is a Technology Project, that fact must be mentioned early in the document. For example, "The proposed Eclipse Phoenix project ..." or "The Buckminister project, a Technology project at Eclipse, is releasing version 0.2 of their framework for early alpha feedback from the community." |
===Infrastructure uses of the Project Name=== | ===Infrastructure uses of the Project Name=== | ||
| − | ====Newsgroup | + | ====Forums and Newsgroup==== |
| − | The project newsgroup name will be <code>eclipse | + | The project forum/newsgroup name will be <code>eclipse.[shortname]</code>. The short name can be an abbreviation of the descriptive name, short name, nickname, or acronym, e.g., eclipse.ecf, eclipse.buckminister, etc. |
====Mailing Lists.==== | ====Mailing Lists.==== | ||
| − | New projects typically have a single <code> [shortname]-dev@</code> mailing list. When multiple components are being developed by independent teams, the new project may choose to have additional mailing lists of the form <code>[shortname]-[component]-dev@</code>. The short name is the same as above. | + | New projects typically have a single <code>[shortname]-dev@</code> mailing list. When multiple components are being developed by independent teams, the new project may choose to have additional mailing lists of the form <code>[shortname]-[component]-dev@</code>. The short name is the same as above. |
====Package and Component Names.==== | ====Package and Component Names.==== | ||
Revision as of 09:20, 21 June 2011
Contents
Project Naming Policy
Naming and branding are challenging issues. The Eclipse brand is important. To help provide a consistent brand for Eclipse, projects are instructed follow these project naming guidelines. The best names are descriptive but at the same time memorable.
The policy for project names is:
- Descriptive Name Projects are encouraged to use a descriptive name - a name that is useful when placed into a box on an Eclipse architecture diagram. For example "Graphical Modeling Framework", "Trust Framework" or "Component Assembly Tools".
- Descriptive names do not tend to include the words "Eclipse" or "Project". The project name should work with or without the prefix and/or suffix. For example, "Graphical Modeling Framework", "Eclipse Graphical Modeling Framework", "Graphical Modeling Framework Project", and "Eclipse Graphical Modeling Framework Project" are equally understandable.
- Descriptive names may optionally include the words "Framework" or "Tools" if the project has more of an emphasis on extensible frameworks, or more on exemplary tools. Eclipse projects always provide both but may be tailored more toward one or the other. When choosing to use these words, the team should consider that "Framework" and "Tools" mean different things to different people and may even be ecoming overused.
- Top-level projects may optionally include the word "Platform" instead of "Framework". Or not.
- Short Name Projects require a short name; this name is used to represent the project in the Eclipse Foundation database, and it
- The short name may contain lowercase alphanumeric characters, dashes, and underlines. The short name may not contain periods (.)
- The short name is joined with the short name of the parent project(s) to form a qualified identifier for the project that is used as a key on many of the webpages and services generated and/or maintained for your project by the Eclipse Foundation. e.g. Project "Woolsey" has a short name of "woolsey"; it's qualified name is "technology.dash.woolsey", indicating that it is a subproject of the "Dash" project which is itself a subproject of "Technology".
- Nicknames. If a team strongly prefers to use a nickname style project name, instead of a purely descriptive project name, there should also be a longer "more official, but less often used" (MOLU) combination nickname-descriptive project name. For example, the "Higgins" project has a MOLU name of "The Higgins Trust Framework".
- Acronym. Most descriptive names are sufficiently long that it can be convenient to abbreviate them in some way. For example, the Eclipse Communication Framework shortens to ECF.
- Not a Product Name. To avoid confusion between Eclipse projects and commercial products, Eclipse projects may not be named after commercial products and vice versa.
As a defensive measure, the Eclipse Foundation holds the trademark to the Project names on behalf of the Projects - this prevents companies from misusing or misrepresenting their products as being the Projects.) The EMO will initiate a trademark review prior to scheduling a Creation Review. Existing trademarks must be transfered to the Eclipse Foundation (please see the Trademark Transfer Agreement).
Using the Project Name
Every public use of the project name - in a web page, a presentation, a press release, an article, etc. - should follow these guidelines:
- The first use of the Project Name uses the entire Descriptive Name and may include the optional Nickname. For example, "The Eclipse Component Assembly Project (Buckminister)". Subsequent references to the project may use the Nickname, e.g., "Buckminister".
- If the project is in the Proposal Phase, or is a Technology Project, that fact must be mentioned early in the document. For example, "The proposed Eclipse Phoenix project ..." or "The Buckminister project, a Technology project at Eclipse, is releasing version 0.2 of their framework for early alpha feedback from the community."
Infrastructure uses of the Project Name
Forums and Newsgroup
The project forum/newsgroup name will be eclipse.[shortname]. The short name can be an abbreviation of the descriptive name, short name, nickname, or acronym, e.g., eclipse.ecf, eclipse.buckminister, etc.
Mailing Lists.
New projects typically have a single [shortname]-dev@ mailing list. When multiple components are being developed by independent teams, the new project may choose to have additional mailing lists of the form [shortname]-[component]-dev@. The short name is the same as above.
Package and Component Names.
Typical package and component names are org.eclipse.[shortname].[component]. The short name is the same as above, for example, org.eclipse.ecf.core, org.eclipse.componentassembly.ui, and org.eclipse.buckminister.connector
This page is moderated by Ian Skerrett (Eclipse Foundation)