Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWayne Beaton2016-10-18 16:51:52 -0400
committerWayne Beaton2016-10-18 16:51:52 -0400
commit427ee57a857020f3dc6ab0c54d3862bf28f43891 (patch)
tree78e5e872225202d92b26d520fb8f944c53d40f62
parent8af9b4543b0f0a467f958ffe591b78eb0588338a (diff)
downloadorg.eclipse.dash.handbook-427ee57a857020f3dc6ab0c54d3862bf28f43891.tar.gz
org.eclipse.dash.handbook-427ee57a857020f3dc6ab0c54d3862bf28f43891.tar.xz
org.eclipse.dash.handbook-427ee57a857020f3dc6ab0c54d3862bf28f43891.zip
Add a checklist.
As part of this activity, I've moved the branding checklist out of the trademarks document and into the new file.
-rw-r--r--source/chapters/checklist.adoc104
-rw-r--r--source/chapters/trademarks.adoc29
-rw-r--r--source/config.adoc1
-rw-r--r--source/eclipse.adoc2
4 files changed, 108 insertions, 28 deletions
diff --git a/source/chapters/checklist.adoc b/source/chapters/checklist.adoc
new file mode 100644
index 0000000..e827ba0
--- /dev/null
+++ b/source/chapters/checklist.adoc
@@ -0,0 +1,104 @@
+[[checklist]]
+== Project Checklist
+
+This checklist is provided as a convenience and is included primarily as
+a guideline or tool to ensure that {forgeName} projects are doing the right
+sorts of things to attract community and grow. We've tried to strike a balance
+between being concise while being comprehensive.
+
+The Eclipse Foundation staff and Project Management Committee members will
+use this checklist as part of their evaluation during a <<release-review,Release Review>>.
+
+All projects must conform to the <<trademarks,branding guidelines>> before engaging
+in any Release or Graduation Review (specific examples are described below).
+
+=== Code
+
+* All project code is managed in source code repositories provided by The Eclipse Foundation;
+* All source files include a copyright and license header;
+* All project source code repositories include a https://wiki.eclipse.org/Architecture_Council/Contributor_Guide_Recommendation[CONTRIBUTING] file in the root;
+* Naming Conventions followed:
+** e.g. +{namespace}.<short-name>.<component>[.*]+ for Java packages and OSGi Bundles;
+* Provider information is set to the project's formal name:
+** e.g. the 'Bundle-Vendor' entry set to "Eclipse Foo" in OSGi Bundles; or
+** e.g. the 'project' and 'organization' names are set to "{forgeName} Foo" in Maven `pom.xml` files;
+* Every module contains an +about.html+ file as required by the {legalDocumentationUrl}[guide to the legal documentation]; and
+* Features names and descriptions are captured, are spelled correctly, use proper grammar, and contain content that is actually useful for the intended audience.
+
+=== Downloads
+
+Most projects provide binary/compiled 'downloads' of their software, intended
+for consumption by their various communities. If the project does not provide
+downloads, then that should be stated on the project's website.
+
+* All generated artifacts include only intellectual property that has been subject to the IP Due Diligence Process;
+* All distributed third-party code has been approved by the IP Team;
+* The project website and PMI page includes links for artifacts;
+* <<starting-project-phases,Incubation branding>> (if applicable) is included on distributed artifacts; and
+* Subject to limitations of specific technologies, the https://wiki.eclipse.org/Version_Numbering[Version numbering] rules are followed.
+
+=== Project Metadata
+
+Project metadata is specified and maintained using the <<pmi, Project Management Interface>>.
+
+* The formal name, e.g. '{forgeName} Foo(TM)', is used in the project title;
+* The formal name including appropriate marks is used in the first mention in the text of the project description, and scope;
+* The project description starts with a single paragraph that can serve as an 'executive summary';
+* Source code repository references are up-to-date; and
+* Download links and information are up-to-date.
+
+=== Release Metadata
+
+Release metadata is specified and maintained using the <<pmi, Project Management Interface>>. Project teams
+are required to create a metadata entry for every official release (including major, minor, and service
+releases).
+
+* At least one release record describes a future release; and
+* The release record includes a description that starts with a single paragraph that can serve as an 'executive summary'.
+
+=== Development Website
+* Is hosted on Eclipse Foundation-provided infrastructure;
+* Uses the formal name including appropriate marks, e.g. '{forgeName} Foo(TM)', on the page title, first mention in the text, and on all prominent references to the project;
+* Project incubation status (if applicable) is correctly noted;
+* Includes a concise description of the project (with all necessary marks); and
+* The <<trademarks-website-footer,standard navigation>> links (e.g. {wwwUrl}) are included in the website footer.
+
+=== Logos and graphics
+* Project logo includes the trademark symbol; and
+* Are used consistently.
+
+=== Company Logos
+
+Company logos may optionally be included on a project website, but
+only if the following conditions are met.
+
+* The company is a http://eclipse.org/membership/[member] of the
+Eclipse Foundation;
+* At least one project committer is an employee of the company
+in question; and
+* The committer is active (i.e. they have made at least one commit in
+the last three months)
+
+=== Community Portals and Related Websites
+
+<<trademark-external-community,Community portals>>, regardless of who owns and maintains
+them must conform to the branding guidelines. If you discover a website that does not
+conform to these guidelines (and it is not within your power to effect the changes yourself),
+send a note to {emoEmail} to request assistance.
+
+* The formal name including appropriate marks, e.g. '{forgeName} Foo(TM)', is used on the page title, first mention in the text, and on all prominent references to the project;
+* <<trademarks-external-attribution,Attributions>> are provided for all Eclipse Foundation marks;
+* All references to {forgeName} open source projects use the formal name with appropriate marks;
+* Trademark and registered trademark symbols are used appropriately;
+* Developers are directed to the official project website for information regarding contribution or related development activities;
+* Ownership of the domain name (especially if it includes the project name) has been transferred to the Eclipse Foundation; and
+* The domain is regarded and used exclusively as a community portal (i.e. is is not presented as the official project website).
+
+=== Announcements, News items, Blog posts, ...
+
+All announcements regarding project milestones issued by the project must conform to the branding
+guidelines.
+
+* The formal name including appropriate marks, e.g. '{forgeName} Foo(TM)', is used in the title, first mention in the text, and on all prominent references to the project;
+* <<trademarks-external-attribution,Attributions>> are provided for all Eclipse Foundation marks; and
+* All references to {forgeName} open source projects use the formal name with appropriate marks.
diff --git a/source/chapters/trademarks.adoc b/source/chapters/trademarks.adoc
index d55db44..2cb55c2 100644
--- a/source/chapters/trademarks.adoc
+++ b/source/chapters/trademarks.adoc
@@ -352,7 +352,7 @@ name.
In Java, for example, package names must start with +{namespace}+ and use
their short name in the third-segment  (i.e. follow the pattern
-+{namespace}.<shortname>.<component>+), e.g. +{namespace}.foo.core+,
++{namespace}.<short-name>.<component>+), e.g. +{namespace}.foo.core+,
+{namespace}.foo.ui+, and +{namespace}.foo.connector+. Component
names are left to the discretion of the project team.
@@ -468,33 +468,6 @@ Eclipse, the Eclipse logo, and the Eclipse Woolsey project logo are
either registered trademarks or trademarks of The Eclipse Foundation in
the United States and/or other countries.
-[[trademarks-checklist]]
-=== Branding Checklist
-
-All projects must conform to these branding guidelines before engaging
-in any Release or Graduation Review.
-
-Project branding checklist:
-
-[square]
-* The primary development website is hosted on Eclipse
-Foundation-provided infrastructure;
-* The primary development website is accessible through
-www.eclipse.org/<short-name>;
-* The first occurrence of project name on all webpages uses the formal
-name and is prefixed with "Eclipse";
-* The project website includes a concise description of the project (and
-includes all necessary marks);
-* The required navigation links (e.g. www.eclipse.org) are included in
-the website footer;
-* Attributions for all Eclipse Foundation marks are included, and
-trademark and registered trademark symbols are used appropriately;
-* Attributions for all other marks are included, and trademark and
-registered trademark symbols are used appropriately;
-* Logos and graphics include the trademark symbol;
-* The product logo is used consistently; and
-* PMI metadata complete and up to date
-
[[trademarks-notes]]
=== Important Notes
diff --git a/source/config.adoc b/source/config.adoc
index 683dbf8..f9ad858 100644
--- a/source/config.adoc
+++ b/source/config.adoc
@@ -13,6 +13,7 @@
:developerPortalUrl: http://portal.eclipse.org
:committerQuestionnaireUrl: http://portal.eclipse.org
:committerGuidelinesUrl: http://www.eclipse.org/legal/committerguidelines.php
+:legalDocumentationUrl: http://www.eclipse.org/legal/guidetolegaldoc.php
:ipDueDiligenceUrl: http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
:ipThirdParty: http://www.eclipse.org/org/documents/Eclipse_Policy_and_Procedure_for_3rd_Party_Dependencies_Final.pdf
:ipPolicyUrl: http://eclipse.org/org/documents/Eclipse_IP_Policy.pdf
diff --git a/source/eclipse.adoc b/source/eclipse.adoc
index c064158..ccea925 100644
--- a/source/eclipse.adoc
+++ b/source/eclipse.adoc
@@ -43,6 +43,8 @@ include::chapters/trademarks.adoc[]
// include::chapters/links.adoc[]
+include::chapters/checklist.adoc[]
+
include::chapters/glossary.adoc[]
include::chapters/contact.adoc[]

Back to the top