Write a JSR |
Submit a JSR |
JSR Review |
EG formation |
Early Draft Review |
Public Review |
Proposed Final Draft |
Final Ballot |
Spec Lead Guide
This page lists detailed instructions for the Maintenance process for JSRs under JCP 2.11. For other versions, or for an overview of the Maintenance process, please return to the Spec Lead Guide: Maintenance Review page.
Grandfathered JSRs (Specifications that have been developed outside the JCP) that are coming into the JCP enter at this stage and are assigned a 9xx number. If you are the Maintenance Lead for one of these Grandfathered JSRs, you still follow the Maintenance process applicable to your JSR.
Maintenance for JCP 2.11
In Maintenance of a JSR, the Maintenance Lead must maintain an Issue Tracker for the specification. The Issue Tracker is a publicly readable mechanism that tracks the nature and disposition of issues with the specification that have been reported or requested by the community. Periodicially, the Maintenance Lead then uses the process of Maintenance Review or the process of Errata Maintenance Release to update the specification to incorporate those changes.
Maintenance Review process
This is the Maintenance Review process:
- You gather suggestions on revisions to the Specification.
- You submit the materials to email@example.com so the PMO can initiate the Maintenance Review (see "Maintenance Review checklist," below).
- After the requested duration (14 - 90 days) the review ends.
- The 7-day Maintenance Review Ballot begins.
- If the Maintenance Review Ballot is approved, you submit the Maintenance Release materials to firstname.lastname@example.org before the deadline you set (see "Maintenance Release checklist," below). If the Maintenance Review Ballot is not approved, you go back to #1. If you don't submit the Maintenance Release by your deadline, the EC holds a Maintenance Renewal Ballot.
- The PMO posts and announces the Maintenance Release of your specification. Go back to #1 to start the cycle over again for the next revision.
Maintenance Errata Release
This is the process to posts a Maintenance Errata Release:
- You gather suggestions on correcting typographical errors in the specification.
- You revise the specification and submit the materials to email@example.com.
- The PMO posts and announces the Maintenance Errata Release. Go back to #1.
Maintenance Review checklist:
For a Maintenance Review, you will need to submit all of the following to the PMO (firstname.lastname@example.org) via e-mail, specifying the JSR number and "Maintenance Review" in the subject line:
- The URL of your oIssue Tracker (a list of all suggestions you received for the specification from the public, as well as your rationale for including or excluding these suggestions from your specification).
- The summary of changes you intend to make to the specification. This can be a diff between the version of the specification from the last milestone and the updated specification, or it can be a list of proposed changes.
- The length of the Review (14 - 90 days). If you do not specify a length, it will default to a standard length of 30 calendar days. During the Maintenance Review, you can request to extend the length of the review by sending e-mail to email@example.com at least two days before the scheduled end date requesting the extension. 90 days is the maximum length of a Maintenance Review.
- A description of your communication channel - how the community can provide feedback on the proposed changes.
- The revised final licenses for the RI and TCK (or the URL where they were posted previously and confirmation that they are unchanged from those)
- The date by which you commit to deliver the Maintenance Release materials to the PMO
The PMO takes the information you provide and posts it to the web site. When it is ready, the Maintenance Review is announced to the community and the Executive Committee. At the next Tuesday after the review closes, a one-week Maintenance Review Ballot begins.
If the Executive Committee approves the ballot, Maintenance Release can commence. As part of the Maintenance Review, the Maintenance Lead provided his/her own date for when the Maintenance Release materials will be provided to the PMO (assuming the EC approves the ballot).
Here are the materials you will need to provide for a Maintenance Release by the deadline you submitted in the Maintenance Review earlier:
- The revised final Specification, in pdf or zip format (be aware that Javadoc files must be zipped).
- The URL of the publicly accessible Reference Implementation (or publicly accessible instructions on how to access the RI)
- The URL of the publicly accessible Technology Compatibility Kit (or publicly accessible instructions on how to access the TCK)
- the answer to the following questions, provided separately for each specification file you provide for posting:
A. Does the file include software codes in the following format:
Binary : Yes ______ No ______
Source (compilable) : Yes _____ No _____
Javadocs : Yes _____ No _____
B. Do the codes or the file call on, contain, use, or demonstrate encryption technology?
Yes _____ No _____
If yes, please describe in detail.
The PMO will use your answers to update the Export Classification Control Number (ECCN) with the US State Department for the posting of the Maintenance Release specification.
- The version number of the specific specification document you are submitting, the anticipated release date, and the full corporate name and address of the Spec Lead Member(s). This will be used in the final specification license.
- The name and contact information for the Maintenance Lead(s)
- The URL of the updated Issue List
- An Answer to the question: Do you intend to continue developing this Specification through Maintenance Reviews or a follow-on JSR?
Updating the materials during the review: it's possible to alter the proposed changes during the review; sometimes early feedback from the community points to additional issues. You may submit updated materials to firstname.lastname@example.org with the subject line "Update to JSR XXX Maintenance Review" at any point during the review up to 5 days before the ballot is to begin. After that deadline, you may only post updates to the review materials if you first extend the length of the review (up to a maximum of 90 days).
If the Maintenance Lead misses their own deadline for submitting the Maintenance Release materials, the EC will hold a Maintenance Renewal Ballot to determine whether the Maintenance Review is invalidated or not. If the Executive Committee rejects the Maintenance Renewal Ballot, the changes from the Maintenance Review are not approved, the specification, RI, and TCK are not revised, and the Maintenance Release materials should not be submitted to the PMO. In such a case, you are welcome to prepare for another Maintenance Review.
Turnaround time: With any public posting of a specification to jcp.org, the PMO will post the spec and related materials within 3 business days of receiving all the above materials at email@example.com. You may check the status of your Maintenance Review or Maintenance Release submission on the JCP Github page, where issues are filed for each JSR milestone submission.
The PMO welcomes suggestions and requests from the Spec Leads for improvements of this guide and the process: firstname.lastname@example.org