Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API-Readiness-Checklist.md to RM project #29

Merged
merged 10 commits into from
Jun 11, 2024
15 changes: 15 additions & 0 deletions documentation/API-Readiness-Checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# API Readiness Checklist
tanjadegroot marked this conversation as resolved.
Show resolved Hide resolved
| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> | Status for <api-name> <version> in rX.Y |
|----|----------------------------------------------|-------|-------------------|---------|--------|
| 1 | API definition | M | M | M | M |
| 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 |
| 6 | User stories | O | O | O | M |
| 7 | Basic API test cases & documentation | O | M | M | M |
| 8 | Enhanced API test cases & documentation | O | O | O | M |
| 9 | Test result statement | O | O | O | M |
| 10 | API release numbering convention applied | M | M | M | M |
| 11 | Change log updated | M | M | M | M |
| 12 | Previous public-release was certified | O | O | O | M |
hdamker marked this conversation as resolved.
Show resolved Hide resolved