| [jakarta.ee-spec.committee] spec review checklist |
I started to create a checklist based on our instructions and the problems we've seen so far. I haven't tried to reconcile this with the "common mistakes" document we started, or with the list David sent earlier, but maybe this will be helpful. Let me know what you think and I can update it as needed.
# Spec Review Checklist 1. Spec PR * PR uses [template](https://github.com/jakartaee/specifications/blob/master/pull_request_template.md) * Directory of form \<spec>/x.y * PDF of form \<spec>-spec-x.y.pdf * HTML of form \<spec>-spec-x.y.html * Index page \<spec>/x.y/_index.md following [template](https://github.com/jakartaee/specification-committee/blob/master/spec_page_template.md) * Index page \<spec>/_index.md * No other files * Staging repository link of the form https://oss.sonatype.org/conte/repositories/staging/jakarta/\<spec>/jakarta-\<spec>-api/x.y.z/ * EFTL TCK link of the form http://download.eclipse.org/.../*.zip * Compatibility certification link of the form https://github.com/eclipse-ee4j/\<project>/#\<issue> * Second PR for just apidocs 2. _index.md * Link to spec pdf * Link to spec html * Link to apidocs * Link to final TCK download zip file of the form https://download.eclipse.org/jakartaee/\<spec>/x.y/*\<spec>-tck-x.y.z.zip * Link to API jar file of the form https://search.maven.org/artifact/jakarta.\<spec>/jakarta.\<spec>-api/x.y.z/jar * Name of and link to at least one Compatible Implementation 3. javadocs * Footer contains Eclipse copyright and link to license * ESFL license is included, usually as doc-files/speclicense.html 4. Spec PDF * Correct spec title * Version number of the form x.y, not x.y.z * Correct Eclipse copyright line * No DRAFT or SNAPSHOT 5. Spec HTML * Same as PDF 6. TCK zip file * README file * EFTL license file * User's Guide * How to test the Compatible Implementation(s) listed in _index.md above with the TCK (may be in UG) 7. TCK User's Guide * Software requirements listed * Installation and configuration described * How to run tests * Where to file challenges 8. Compatibility certification request * Request follows [template](https://github.com/jakartaee/specification-committee/blob/master/compatibility-certification-request.md) * SHA-256 fingerprint matches staged TCK zip file 9. TCK results summary * Page is hosted by Compatible Implementation project * Includes all information from certification request * Summary includes tests passed, failed, errors