...
- copy the API-Readiness-Checklist.md file(s) to the API Sub Project repository in the home/code folder.
- rename the file to include the prefix <API name> plus a dash ("-") e.g. quality-on-demand-API-Readiness-Checklist.md
- provide each release asset as indicated in the column corresponding to the release type
- for an available asset
- update the Status column with "Y" (yes) if the release asset is available or fulfilled in the current release, or "N" (no) otherwise. Example: an intermediate pre-release may not yet provide all mandatory release assets for the release type.
- update the Comments column with the link to the asset (if applicable), and any other additional comments as needed
- update the Status column with "Y" (yes) if the release asset is available or fulfilled in the current release, or "N" (no) otherwise. Example: an intermediate pre-release may not yet provide all mandatory release assets for the release type.
NOTE: the checklists of the latest a release-candidate and the checklist of a subsequent public API version are may be the same.
Checklist explanation
...
Nr | API release assets | alpha | release- candidate | initial public (v0.y.z) | stable public (vx.y.z, x>=1) | Status | Comments |
1 | API definition | M | M | M | M | link | |
2 | Design guidelines from Commonalities applied | O | M | M | M | ||
3 | Guidelines from ICM applied | O | M | M | M | ||
| 4 | API versioning convention applied | M | M | M | M | ||
5 | API documentation | M | M | M | M | link | |
6 | User Stories | O | O | O | M | link | |
7 | Basic API test cases & documentation | O | M | M | M | link | |
78 | Enhanced API test cases & documentation | O | O | O | M | link | |
89 | Test result statement | O | O | O | M | link | |
910 | API release numbering convention applied | M | M | M | M | ||
1011 | Change log updated | M | M | M | M | link | |
1112 | Previous public-release was certified | O | O | O | M |
...