Simple steps to new Eclipse specifications

The Eclipse Foundation Specification Process

Wayne Beaton
© Shutterstock / Sadovski

How should software be implemented? At the Eclipse Foundation, this is decided by the specification document. Wayne Beaton, the Director of Open Source Projects at the Eclipse Foundation, explores the process for how project specifications are created and what this means for Jakarta EE.

The Eclipse Foundation Specification Process (EFSP) defines a general framework for developing specifications in open source at the Eclipse Foundation. At the heart of the EFSP is the notion of an open source project and, much like an open source software project, an open source specification project is concerned with creating various artifacts in an open and transparent manner. In the case of a specification project, however, at least one of the artifacts that’s produced is a specification document that describes how software should be implemented.

The EFSP extends the Eclipse Development Process (EDP). The EDP defines the governance of open source projects at the Eclipse Foundation. This EDP describes, for example, our open source “rules of engagement” (open, transparent, meritocratic), how open source projects are structured, roles and relationships, and our review process around releases. The EFSP adds a few extra checks and balances.

To support specification development, we’ve extended our open source project model to include a specific notion of a specification project. At a basic level, designation as a specification project is a flag that indicates that the open source project that is concerned with producing one or more specifications. In practical terms, unlike regular Eclipse open source projects, specification projects are explicitly aligned with exactly one Eclipse Foundation working group; the specification committee designated by the working group plays a key role in the governance of the project.

A full discussion of working groups is out of scope; the short version is that while open source projects provide a means for individuals to work together, working groups provide a means for companies to work together. A specification committee represents the interests of a working group in the specification process.

One of the roles of the specification committee is to ensure that specification work stays in-scope. Scope has always been an important concept for Eclipse open source projects: all new Eclipse open source projects are required declare their scope as part of their proposal; that scope must be approved by the Eclipse Foundation’s Executive Director and the membership at large. All Eclipse projects are required to ensure that their work remains within the defined scope (and a change in scope requires a formal community review).

Scope is especially important for specification projects. So much so, that our regular processes are extended to require specification committee approval of the scope before a project can even be created, as well as approval of release plans and all corresponding reviews to ensure that work done by the project falls within the defined scope. The specification committee must also approve of any changes in scope.

Like regular Eclipse open source projects, a Specification Project starts life as a Proposal with a description, scope, list of committers, and more; goes through an iterative development cycle that produces one or more Milestone builds; and then engages in a release process.

eclipse specification process

The specification committee needs to approve of the creation of a specification project from a proposal by taking a role in the creation review. Following successful creation and provisioning of project resources, the specification project begins development. During the development cycle, the project team must produce at least one milestone build of the specification’s content (documentation and technical artifacts) to solicit feedback, and at least one of the milestone builds must serve as a trigger to engage in a progress review.

Progress reviews, a new addition to the EDP introduced with the 2018 version, are roughly equivalent to release reviews, but have the intent of ensuring that the specification project is progressing in a manner that will ultimately result in a successful release. A specification committee and project leadership may compel a specification project to engage in additional progress reviews.

For a progress review to conclude successfully, the Project Management Committee (PMC), and Eclipse Management Organization (EMO) must validate that the work done to date has been in-scope, that the project team is following the EDP and EFSP, and that the Eclipse Foundation’s Intellectual Property Policy is being correctly implemented.

At the end of every release cycle, the project team must produce a release candidate build that we label as a specification version and then engage in a release review. For a release review, the PMC, EMO, and specification committee all engage in the same sorts of activities that they do for a progress review, but with the understanding that approval results in the ratification of the specification and promotion to an official status.

Following a successful release review, the final release version of the specification artifacts is considered ratified and morph into what the process refers to as a final specification. It is the final specification that must be used to build compatible implementations.

Following a successful first release (and every subsequent release thereafter), and before engaging in any further development of the specification, the project team must assemble and present their plan for review by the specification committee via plan review. The notion of a plan review is specific to the EFSP (since plan reviews are not part of the EDP, no formal involvement from the PMC is required). A plan review provides the Specification Committee with an opportunity to ensure that the plan for the next specification version is in-scope, fits within the overall vision of the working group, and is otherwise charting a path to eventual ratification and release. After the Plan is approved, the Project Team engages in Development as before.

We’ve crafted the EFSP to provide just enough process to satisfy the legal requirements that come from doing specification work while honoring the open and transparent nature of open source development defined by the EDP. In the coming months, we’ll apply the EFSP to the Jakarta EE specifications currently hosted under the Eclipse EE4J Top-Level Project. As part of that process, we’ll customize the process for the Jakarta EE working group and-as we learn more by applying the process-tweak it a bit. Specification work in open source is a relatively new concept; it’s an exciting time.



This post was originally published in the January 2019 issue of the Eclipse Newsletter: 2019 in Focus.

For more information and articles check out the Eclipse Newsletter.

Eclipse Photon

Wayne Beaton

Wayne Beaton is the Director of Open Source Projects at the Eclipse Foundation, a former Minor Hockey Chauffeur, a Martial Artist, and huge fan of the Oxford Comma. Follow him on Twitter @waynebeaton.

Leave a Reply

Your email address will not be published.