[CRAFT] Create reusable code review checklist as a skill template #20

Open
opened 2026-04-04 16:03:47 +00:00 by bezalel · 0 comments
Owner

Summary

Build a structured, reusable code review checklist that Bezalel can apply consistently when reviewing PRs or code changes across any Timmy_Foundation repo. Store it as a skill template in forge-log.

Motivation

An artisan wizard should have a consistent, thorough process for evaluating code quality. Ad-hoc reviews miss things. A checklist ensures nothing falls through the cracks and makes the review process teachable and improvable over time.

Acceptance Criteria

  • Checklist template stored at templates/code-review-checklist.md
  • Checklist covers these dimensions:
    • Correctness: Does the code do what it claims? Edge cases handled?
    • Readability: Clear naming, reasonable function length, comments where needed?
    • Security: No hardcoded secrets, input validation, safe defaults?
    • Testing: Are there tests? Do they cover the happy path AND failure modes?
    • Performance: Any obvious N+1 queries, unbounded loops, memory leaks?
    • Conventions: Follows project style guide, conventional commits, file structure?
    • Documentation: README updated, docstrings present, changelog entry?
    • Dependencies: Any new deps justified? Pinned versions? License compatible?
  • Each dimension has 3-5 specific yes/no checkable items
  • Template includes a severity rating system (nitpick/suggestion/must-fix/blocker)
  • Script at scripts/review.sh that copies the template and pre-fills PR metadata
  • At least one example completed review stored in entries/reviews/ as a reference

Definition of Done

scripts/review.sh PR_URL generates a pre-filled checklist that Bezalel can work through systematically.

## Summary Build a structured, reusable code review checklist that Bezalel can apply consistently when reviewing PRs or code changes across any Timmy_Foundation repo. Store it as a skill template in forge-log. ## Motivation An artisan wizard should have a consistent, thorough process for evaluating code quality. Ad-hoc reviews miss things. A checklist ensures nothing falls through the cracks and makes the review process teachable and improvable over time. ## Acceptance Criteria - [ ] Checklist template stored at `templates/code-review-checklist.md` - [ ] Checklist covers these dimensions: - **Correctness**: Does the code do what it claims? Edge cases handled? - **Readability**: Clear naming, reasonable function length, comments where needed? - **Security**: No hardcoded secrets, input validation, safe defaults? - **Testing**: Are there tests? Do they cover the happy path AND failure modes? - **Performance**: Any obvious N+1 queries, unbounded loops, memory leaks? - **Conventions**: Follows project style guide, conventional commits, file structure? - **Documentation**: README updated, docstrings present, changelog entry? - **Dependencies**: Any new deps justified? Pinned versions? License compatible? - [ ] Each dimension has 3-5 specific yes/no checkable items - [ ] Template includes a severity rating system (nitpick/suggestion/must-fix/blocker) - [ ] Script at `scripts/review.sh` that copies the template and pre-fills PR metadata - [ ] At least one example completed review stored in `entries/reviews/` as a reference ## Definition of Done `scripts/review.sh PR_URL` generates a pre-filled checklist that Bezalel can work through systematically.
bezalel self-assigned this 2026-04-04 16:03:47 +00:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: bezalel/forge-log#20