17.5 Review Checklist

Go To Top

Return to Git and Review Workflow

Reviewers should inspect each change against the Phase 0 Baseline. Review should not focus only on whether the code runs. It should also check traceability, reproducibility, naming, documentation, Configuration, discipline in generated Artifacts, logging, exception handling, and Evidence.

A reviewer should check:

1. The change has a clear purpose.
2. The change belongs in the Phase 0 Baseline.
3. The changed Artifacts live in the correct Repository locations.
4. Names follow the conventions defined in Section 7.
5. Handwritten and generated Artifacts remain separated.
6. IDL changes follow the rules in Section 9.
7. Node changes follow the pattern in Section 10.
8. Control Plane changes follow Section 11.
9. Data Plane changes follow Section 12.
10. Script changes follow Section 13.
11. Container changes follow Section 14.
12. Logging and observability changes follow Section 15.
13. Exception handling changes follow Section 16.
14. Tooling changes align with the applicable checklist instance defined in Section 6.
15. Tests or validation Evidence support the change.
16. Documentation changed when the implementation changed.
17. No local, temporary, personal, or machine-specific Artifacts entered the Baseline.

Reviewers should check spelling, grammar, terminology, and active-voice guidance against Section 7.11 when reviewing documentation, comments, file headers, script help text, Configuration descriptions, generated documentation templates, catalogue entries, and acceptance Evidence.