An API review checklist is an ordered set of inspection criteria for deciding what human reviewers should examine after automated linting and breaking-change checks run. Automation handles covered style and compatibility rules; reviewers focus on design quality, unresolved warnings, and consumer needs. section 5.2.5
Use the checklist to review a pull request in this order:
- Confirm linting and breaking-change checks completed successfully; inspect INFO and WARN results requiring attention. section 5.2.5
- Trace the user journey and verify that the design change helps users perform their intended job. section 5.2.5
- Read the rendered API reference and check whether it clearly explains the API goal and user benefit. section 5.2.5
- Check resource modeling, required operations, API boundaries, and the consistency of attribute and resource names. section 5.2.5
- Add comments for missing operations, unclear names, boundary problems, inconsistencies, and concerns raised during an earlier review. section 5.2.5
