Code Review Overview
Template Library
Code Review Overview
Define review scope, source implementation evidence, changed areas, review objectives, known risks, review strategy, reviewers, and acceptance criteria.
ES-108
Review Scope
Engineering Review
Template purpose
Use this template to define the review scope before reviewing PRs, branches, implementation evidence, AI assistance, guardrails, and integration risk.
Project
<Project name>
Document control
| Field |
Value |
| Artifact owner |
<owner> |
| Primary reviewers |
<reviewers> |
| Status |
<draft / in review / accepted / revised> |
| Last updated |
<YYYY-MM-DD> |
| Related Engineering Stage |
ES-108 — Code Review and Integration |
| Project workspace target |
docs/project-workspace/integration/code_review_overview.md |
Review scope
<Describe what is being reviewed.>
Source implementation evidence
docs/project-workspace/implementation/implementation_log.md
docs/project-workspace/implementation/ai_assistance_log.md
docs/project-workspace/implementation/work_item_completion_records.md
docs/project-workspace/implementation/implementation_evidence.md
docs/project-workspace/implementation/verification_notes.md
docs/project-workspace/implementation/implementation_summary.md
Work items reviewed
| Work Item |
Summary |
Implementation Evidence |
Status |
<IW-ID> |
<summary> |
<evidence> |
<ready / incomplete / blocked / deferred> |
Pull requests / branches
| PR / Branch |
Purpose |
Work Items |
Author |
Review Status |
<PR or branch> |
<purpose> |
<IW IDs> |
<author> |
<status> |
Changed areas
| Area |
Changed? |
Notes |
| Components |
<yes / no / partial> |
<notes> |
| Interfaces |
<yes / no / partial> |
<notes> |
| Data structures |
<yes / no / partial> |
<notes> |
| Workflows |
<yes / no / partial> |
<notes> |
| Access control |
<yes / no / partial> |
<notes> |
| AI behavior |
<yes / no / partial / not applicable> |
<notes> |
| Evidence production |
<yes / no / partial> |
<notes> |
| Error handling |
<yes / no / partial> |
<notes> |
| Configuration / deployment |
<yes / no / partial> |
<notes> |
| Documentation |
<yes / no / partial> |
<notes> |
Review objectives
| Objective |
Evidence Needed |
<objective> |
<evidence> |
Known risks entering review
| Risk |
Source |
Review Focus |
<risk> |
<source> |
<focus> |
Review strategy
| Review Domain |
Reviewer |
Evidence |
| Functional correctness |
<reviewer> |
<evidence> |
| Architecture/design conformance |
<reviewer> |
<evidence> |
| Traceability |
<reviewer> |
<evidence> |
| Guardrails |
<reviewer> |
<evidence> |
| AI-assisted implementation |
<reviewer> |
<evidence> |
| Security/privacy/access |
<reviewer> |
<evidence> |
| Verification |
<reviewer> |
<evidence> |
| Repository state |
<reviewer> |
<evidence> |
Acceptance criteria
Review checklist
- [ ] Review scope is clear.
- [ ] Source implementation evidence is identified.
- [ ] Work items and PRs/branches are listed.
- [ ] Changed areas are identified.
- [ ] Review objectives and acceptance criteria are defined.
- [ ] Risks entering review are visible.
- [ ] Reviewer responsibilities are assigned.