Development Resources/HOWTO/Creation Reviews
A creation review is, essentially, the beginning of life for a project. A creation review occurs over a minimum of five business days (generally starting and ending on a Wednesday), during which the community is given one last chance to review and comment on the project proposal. Upon successful completion of the creation review, the project resources are--with assistance from the Webmaster and IP Team--provisioned.
- 1 Overview
- 2 Helpful Documentation from the Eclipse Development Process
- 3 Guidelines for Creation Reviews
Here is what you can expect from a creation review:
Before the Review
- You assemble a proposal. Proposals must be provided using our standard template.
- The proposal document is sent to the EMO for review.
- EMO posts the review in draft form on the eclipse.org/proposals page and invites your feedback.
- EMO posts the live document and invites community review.
- You monitor the communication channel (Proposals Forum) and answer any questions posed about the project
- With assistance from EMO, you solicit two mentors for your project from the Architecture Council.
- When you believe that your project is ready for creation, you request that the EMO schedule a creation review.
- A project proposal must be available for community review for a minimum of two weeks.
- The EMO will initiate a trademark review on your project's proposed name
- The review will be scheduled only after the Eclipse Foundation has taken ownership of your project name's trademark.
Please see Starting a New Project.
During the Review
- Reviews occur over five generally-accepted business days, generally Wednesday to Wednesday.
- You continue to monitor the communication channel and answer any questions related to your project.
- At the end of the review period, the EMO will declare the review complete (reviews tend to end successfully).
Note: There are no calls. We used to have a phone call at the end of each review period; we don't do this anymore.
After the Review
- The EMO will provide you with a link to provision your project
- You provide provisioning information (VCS information, committer contact information, etc.)
- The Webmaster and IP Teams will configure the resources that your project needs.
- Before you commit any code into any eclipse.org VCS, you must take an Initial Contribution through the Eclipse IP Due Diligence Process.
Helpful Documentation from the Eclipse Development Process
Each new project must have a trademark review on the project name and the project nickname (if any). You don't need to specifically request a trademark review; the EMO will initiate it when you request to schedule your Creation Review. We need at least two weeks to complete a trademark review, so please be sure to request your Creation Review at least three weeks before the start of your preferred review period. Earlier than three weeks is even better!
Before your Creation Review is officially scheduled (and appears here), we need three things in place at least one week before the start of the scheduled review period:
- PMC approval
- Mentors named
- Finalized documentation
Please forward an email showing that you have PMC approval for the review. The easiest way to do this is to request approval on your PMC mailing list and forward the response to EMO.
If your proposal does not list your two project mentors, you need to name them before the Creation Review and include the names in the document (See this page for details.)
The review document can be provide in a presentation (i.e. slide) format or in a text document (i.e. HTML, PDF). In fact, the proposal document itself can form the basis of the review document (i.e. add committer bios, required notices, and the review date).
Please submit your documentation in an email attachment to EMO. Many people underestimate the time and effort needed to create the docuware, so be sure to allow enough time for this task. The "official" due date for the document is one week before the scheduled start of the review period (T - one week). However, the document needs to be reviewed by the EMO before posting. If you wait until the due date to submit the first draft and the EMO requests changes, then you'll probably miss your deadline and your review will be postponed. We strongly suggest this timeline for submitting documentation:
- T - two weeks: submit first draft via email to EMO
- T - 10 days: submit final draft after responding to any EMO requests for revision
- T - one week (due date): EMO posts final version on website before sending review announcement email
Please note that that we need both a vendor-neutral format file (HTML, PDF) and the source format that you used to create it; we archive both versions.
Many projects overlook these items when they do their first draft:
- correct copyright notice;
- EPL notice;
- review date;
- mentor names;
- committer bios; and
- Communication Channel
The committer bios don't have to be long or involved, but they should describe each committer's relationship to and history with the incoming code, and/or involvement with the area or technologies covered by the proposal. This document includes some good examples of committer bios.
Guidelines for Creation Reviews
The purpose of the Creation Review is to assess the community and membership response to the proposal, to verify that appropriate resources are available for the project to achieve its plan, and to serve as a committer election for the project's initial Committers. The Eclipse Foundation strives not to be a repository of "code dumps" and thus projects must be sufficiently staffed for forward progress.
What are the Requirements?
As a project proposal leader, you may ask the question "when can we hold a Creation Review for our proposal?"; the primary answer is: "we will hold the Creation Review as soon as you are confident that you have sufficient community support for the proposal". The EMO will assist you in making that decision using (at least) the following criteria: (Note that these criteria are mostly qualitative and thus - except for a few cases - there are no "right answers". The expectation is that proposers will have good answers for questions around these criteria in order to pass the Creation Review.)
The project has sufficient committed developers to achieve its goals. The Eclipse Foundation is not a place to "abandon in public" code; rather, the Eclipse Foundation strives to have active projects with active communities and thus enough developers to move the project along.
Clear and Concise Description.
If the community found any aspects of the proposal confusing, unclear, or using unfamiliar jargon, those areas must be clarified. This is a hard and fast requirement: because the Eclipse community must be able to evaluate the proposal. To do that, they must be able to understand the proposal and thus it must be clear and straightforward and free of marketing-speak.
Successful Eclipse projects are those that collaborate with existing Eclipse, or other open source, projects. Again, it can be hard to start a collaboration before demonstrating the technology, but at the same time it is never too early to start discussing collaborations with other projects. Additionally, it never hurts to join and help an existing project to start establishing those social networks that will make future collaborations on the new project possible.
For each place this new project overlaps an existing Eclipse project, what does the overlapee say about the potential overlap? (Note that the overlapee's opinion is not required to be positive, but that it is important for new projects to understand where they fit and for existing projects to understand what new developments might be coming along.)
In general, a new Eclipse project should start with code. That code may have been developed in-house, or at one of any number of hosting services (e.g. Eclipse Labs).
Extensible frameworks and exemplary tools.
Is this project visibly committed to producing both extensible frameworks and exemplary tools and runtimes built on top of those frameworks? Eclipse is dependent on its projects producing both frameworks for the ecosystem to extend, and end-user tools and runtimes to attract the critical mass of users which enable the ecosystem to exist.
Sufficient Time for the Community.
The minimum time from posting a proposal to a Creation Review is no less than two weeks. Anything less than two weeks of general accepted business days would not be giving the Eclipse membership sufficient notice of new initiatives.
Evidence of Activity.
Proposals that are more than three months old without having been created as a Project are, perhaps, not sufficiently supported by the community as the original proposers believed. Thus proposals older than three months have a somewhat greater burden of proof that they will be viable Eclipse Projects.
Proposals are required to have at least two Mentors before scheduling a Creation Review (see "6.1 Mentors"). The name, corporate affiliation(s), and current Eclipse projects/roles must be listed in the on-line version of the proposal and in the documentation for the Creation Review.
The proposal leads are responsible for recruiting the mentors. Mentors are not recuited or assigned by the EMO. The EMO will provide advice on who the proposal leads might approach as mentors, but neither the proposers nor the suggested mentors are obligated to act on that advice.
Mentors must be existing members of the Architecture Council (see the membership page). The best way to attract the attention of the whole Architecture Council and solicit mentors is to open a bug against Community/Architecture Council.
The Creation Review acts as the new committer election for the initial Committers and thus the on-line version of the proposal and the review documentation must contain the same level of nomination justification and background as an election would.
The Creation Review documents must include short nomination bios of the proposed initial committers. These bios should discuss their relationship to, and history with, the incoming code and/or their involvement with the area/technologies covered by the proposal. The goal is to help keep any legacy contributors connected to new project and explain that connection to the current and future Eclipse membership, as well as justify the initial Committers' participation in a meritocracy.
What are the Best Practices?
In addition to the required pre-requisites, the Eclipse membership is interested in a number of "evidence of best practice" indicators.
Does the project have a community of contributors and users, outside the core developers, who are willing to work towards making this a success? This is a bit of a Catch-22 situation because it is sometimes hard to attract a community before any milestones or releases, but it is also true that projects with limited developers and even fewer users tend not to have much technical impact.
Is this a single company project or a multi-organization effort? If all the committers and contributors are in the same organization or have financial ties to the same organization, the project is at a greater risk of being de-staffed. Brand new projects are not required to be diverse, but projects cannot graduate from incubation without appropriate diversity.
Does the project have a technology scope and focus which will have a reasonable likelihood of success? Projects that are too big will definitely fail; projects that are too small are unlikely to be interesting.
The proposal needs to define the destination/end-game/ultimate objectives for the project. What is the expected time scale for this project? Which is the destination top-level PMC for this project? For example, does this project expect to investigate technology for two years and then have proven itself sufficiently to be integrated into the Platform as a component? Does this project expect to be integrated into a the Web Tools Platform as a sub-project (and thus continue to exist, but under that PMC)? Etc. Note that this section is about a plan, not a commitment, but it does need to be a realistic and believable plan.
Following Eclipse Rules.
The Eclipse Foundation attempts to minimize the number of restrictions and rules placed on projects but there are a few. Because it is the responsibility of each Eclipse committer and project lead to understand and implement this minimal set of standards, a proposal team that shows a disregard (either deliberate or through a lack of effort) for these policies (such as the press guidelines) does not endear themselves to the Eclipse community. The Development Resources page provides pointers to a great deal of information about the Eclipse Development Process and more. At a minimum all prospective committers on the new project should be familiar with the New Committer Handbook.
Preparing the Documentation
The documentation for a Review has traditionally been a slide deck however there is no reason to use slides: a short report/document would work equally well if not better (reports are information dense relative to slides, and that's a good attribute). In fact, the proposal document itself can provide a solid foundation for the review documentation.
In any case, the review document must be/have:
- Neutral File Format. The document must be published in an operating-system neutral file format. PPT and DOC files are not considered neutral. PDF or HTML is currently the best choice. The EMO can convert Open Office and Microsoft Office to PDF if you are unable to do so.
- Archival Quality. The document must be comprehensible and complete on its own without requiring explanation by a human presenter. Archival quality is required because it will be available on the eclipse.org website in perpetuity; future Eclipse users, adopters, and even new project committers will consult it long after the review has been completed.
- Correct Copyright and License. The document is being written (and thus copyrighted) by you, not by the Eclipse Foundation, and thus the copyright statement needs to be by you (or your employer). Similarly, the content should be licensed under the EPL.
The document must cover the issues discussed in the above sections. In addition, it must include:
- Brief, executive summary of the project proposal
- Comments about the community response to the proposal both positive and, if any, negative
- Description of the Initial Contribution. Is this an existing project that is moving some or all of its code to Eclipse?
- Describe extent of move (e.g. some, all, module);
- Name where the code is hosted;
- List existing domain names associated with this code;
- List any trademarks that may apply to the project name;
- List the license(s) was it previously hosted under;
- Provide a list of all past and present contributors and committers (or copyright holders).
- Initial implementation focus - the next step after the Creation Review will be full-speed-ahead implementation, so the project team had better have an initial implementation direction
- Confirmation that the project members and new candidates have read and understand the Eclipse Development Process and their responsibilities towards the community and especially in regards to IP issues.
- Future directions - it's always a good idea to have some idea of where the project is planning to go.
The Review Process
In the past, all reviews were ended with a phone call. We no longer hold calls for reviews.
A review culminates in a review period of at least five generally accepted business days and ultimately end with a succeed/fail determination from the EMO. This review period grants the community one last opportunity to get involved with the project prior to its creation.
Once the review content has been created, the operational side of a Creation Review is:
- Schedule the review by sending email to firstname.lastname@example.org. (Depending on when you read this, you may have already completed this step.)
- Reviews are scheduled at most twice a month, usually on Wednesdays, usually in the morning (USA)/afternoon (Europe)/night (Asia).
- Reviews are grouped up to four at a time.
- At least one week in advance of the start of the review period, you (the proposal lead) sends the review document to email@example.com for posting.
- The EMO posts the document via the website (through the wonders of database-driven web pages, the document is automatically linked from the proposal and from the review notice).
- The EMO announces the review:
- via the eclipse.org/projects web page (as soon as the review is scheduled);
- via the reviews and announcements RSS feed (as soon as the review is scheduled and again when the review document is posted); and
- via email to the committers and membership-at-large mailing lists (at the beginning of the review period).
- At the end of the review period, the EMO will make the succeed/fail determination based on community feedback.
After a Successful Review
After the successful review, and the approval of the Creation Review by the EMO:
- the EMO will ask you to fill out the New Project Provisioning Form
- once your website CVS directory is created, you will provide content for the webpages including:
- send email to firstname.lastname@example.org asking for your project to be marked as "incubation (conforming)" in the Foundation's project database. The EMO will check your website for conformance as per the Board's requirements - this is a required step for participation in the Parallel IP process.
- you submit a Contribution Questionnaire for your initial code contribution using the portal. Note in the comments that you are requesting a Parallel IP process approval to check the initial code into the source code repository before the entire IP review is completed.
- after receiving check-in approval from Eclipse Legal via IPZilla, you can check in the initial code contribution and your project is alive and well.
This page is moderated by the EMO