Checklist Templates#
Templates for Feature Complete and PR Review checklists.
Template A: Feature Complete Checklist#
# Feature Complete: [feature_name]
## 1. Structure Verification
### Domain Layer
- [ ] Entity definition complete (Freezed)
- [ ] Repository Interface defined (I prefix)
- [ ] UseCase implementation complete
- [ ] Failure class defined
- [ ] Unit tests written
### Data Layer
- [ ] Repository implementation complete
- [ ] Serverpod Mixin implemented (if needed)
- [ ] Local Database implemented (if needed)
- [ ] DTO â Entity mapper implemented
- [ ] Caching strategy applied (SWR/Cache-First)
### Presentation Layer
- [ ] Page widget implemented
- [ ] Reusable Widgets extracted
- [ ] BLoC/Cubit implemented
- [ ] Event/State defined (Freezed)
- [ ] Widget tests written
### DI & Routing
- [ ] Injectable annotations added
- [ ] Route defined (Auto_route)
- [ ] Route Guard applied (if needed)
## 2. Code Generation
- [ ] Freezed code generated (*.freezed.dart)
- [ ] Injectable code generated (*.g.dart)
- [ ] Route code generated
- [ ] No build errors
## 3. Testing
- [ ] UseCase tests (Happy path, Error, Edge cases)
- [ ] Repository tests (mocked data source)
- [ ] BLoC tests (initial/event/error)
- [ ] Widget tests (rendering/interaction)
- [ ] All tests passing
- [ ] Coverage 80% or above
## 4. Documentation
- [ ] dartdoc comments on public APIs
- [ ] Explanatory comments on complex logic
- [ ] TODO comments resolved or issues filed
## 5. Internationalization
- [ ] All UI text uses translation keys
- [ ] Translation files updated
- [ ] Pluralization/parameter handling verified
## 6. Performance Optimization
- [ ] const widgets utilized
- [ ] BlocBuilder buildWhen applied
- [ ] ListView.builder used (for long lists)
- [ ] Image cacheWidth/cacheHeight applied
- [ ] Resources released in dispose
## 7. Security Review
- [ ] No hardcoded sensitive information
- [ ] Input validation applied
- [ ] Appropriate error messages
## 8. Accessibility
- [ ] Semantics labels applied
- [ ] Touch target size verified (48x48 minimum)
- [ ] Color contrast verified
## 9. Static Analysis
- [ ] No lint warnings
- [ ] Code formatting complete
## 10. Integration Verification
- [ ] iOS build successful
- [ ] Android build successful
- [ ] Working correctly in development environment
## 11. PR Preparation
- [ ] Meaningful commit messages (Conventional + Gitmoji)
- [ ] Related issues linked
- [ ] Reviewers assigned
## Completion Summary
| Item | Status |
|------|--------|
| Structure Verification | ⎠|
| Code Generation | ⎠|
| Testing | ⎠|
| Documentation | ⎠|
| Internationalization | ⎠|
| Performance Optimization | ⎠|
| Security Review | ⎠|
| Accessibility | ⎠|
| Static Analysis | ⎠|
| Integration Verification | ⎠|
| PR Preparation | ⎠|
Template B: PR Review Checklist#
# PR Review: [PR title]
**PR**: #[number]
**Reviewer**: [name]
**Date**: [YYYY-MM-DD]
## Quick Review (5-minute review)
- [ ] Build success (CI)
- [ ] Tests passing
- [ ] Lint check passing
- [ ] No security issues
- [ ] Breaking Changes verified
## Full Review Checklist
### 1. PR Meta Information
- [ ] PR title follows convention
- [ ] Related issues linked
- [ ] Appropriate labels assigned
### 2. Change Scope
- [ ] PR purpose is clear
- [ ] Focused on a single purpose
- [ ] Change scope is appropriate
- [ ] No unnecessary file changes
### 3. Code Quality
- [ ] Clean Architecture layer separation followed
- [ ] Dependency direction correct
- [ ] No cross-feature module dependencies
- [ ] Meaningful variable/function names
- [ ] No duplicate code (DRY)
### 4. State Management (BLoC)
- [ ] Event/State using Freezed
- [ ] Appropriate state separation
- [ ] Error handling implemented
- [ ] Loading state handled
- [ ] Resources released in dispose
### 5. Testing
- [ ] Tests added for new features
- [ ] Existing tests passing
- [ ] Edge case tests included
### 6. Security
- [ ] No hardcoded secrets
- [ ] No sensitive information in logs
- [ ] Input validation applied
### 7. Performance
- [ ] No N+1 query issues
- [ ] Unnecessary re-renders prevented
- [ ] Image optimization applied
### 8. Internationalization
- [ ] No hardcoded strings
- [ ] Translation keys added
### 9. Accessibility
- [ ] Semantic labels applied
- [ ] Touch target size appropriate
### 10. Documentation
- [ ] Public API documented
- [ ] Breaking Changes documented
## Review Result
**Result**: â
Approved / ð Request Changes / ðŽ Comment
**Summary**:
[Write review summary]
Template C: Review Comment Templates#
Required Fix (Blocking)#
ðī **[Required]** {title}
**Location**: `{file}:{line}`
**Problem**: {problem description}
**Suggestion**:
// Fix code
Cannot merge until this issue is resolved.
Improvement Request (Non-blocking)#
ðĄ **[Improvement]** {title}
**Location**: `{file}:{line}`
**Current code**:
// Current code
**Recommended code**:
// Improved code
{Improvement reason}
Suggestion/Question#
ðĒ **[Suggestion]** {title}
**Location**: `{file}:{line}`
{Question or suggestion content}
Praise#
âĻ **Nice!** {title}
**Location**: `{file}:{line}`
{Praise content}
Template D: Review Result Templates#
Approve#
LGTM! ð
All checklist items verified.
**Verified items**:
- â
Build successful
- â
Tests passing
- â
No security issues
- â
Code quality good
Great work!
Request Changes#
Changes requested.
**Required fixes** (must resolve before merge):
1. {item 1} - `{file}:{line}`
2. {item 2} - `{file}:{line}`
**Recommended fixes** (optional):
1. {item 1}
2. {item 2}
Please re-request review after fixing the required items.
Comment#
Overall looks good. A few questions/suggestions.
**Questions**:
1. {question 1}
2. {question 2}
**Suggestions**:
1. {suggestion 1}
2. {suggestion 2}
Please respond after review.
Template E: Completion Summary Table#
Feature Complete Summary#
## Completion Summary: [feature_name]
| Item | Status | Notes |
|------|--------|-------|
| Structure Verification | â
| Domain/Data/Presentation complete |
| Code Generation | â
| Freezed, Injectable generated |
| Testing | â ïļ | Some Widget tests missing |
| Documentation | â
| dartdoc added |
| Internationalization | â
| Translation keys applied |
| Performance Optimization | â
| const, buildWhen applied |
| Security Review | â
| No hardcoding |
| Accessibility | â ïļ | Some Semantics missing |
| Static Analysis | â
| Lint passed |
| Integration Verification | â
| iOS/Android build successful |
| PR Preparation | â
| Issue linked |
**Overall Status**: ðĄ Some improvements needed (testing, accessibility)
PR Review Summary#
## PR Review Summary: #[number]
| Category | Status | Key Issues |
|----------|--------|------------|
| Meta Information | â
| - |
| Change Scope | â
| - |
| Code Quality | â ïļ | Duplicate code found |
| State Management | â
| - |
| Testing | â | UseCase tests missing |
| Security | â
| - |
| Performance | â ïļ | buildWhen not applied |
| i18n | â
| - |
| Accessibility | â
| - |
| Documentation | â
| - |
**Review Result**: ð Request Changes
**Required Fix**: Add UseCase tests
Template F: CI/CD Verification#
# Check PR status
gh pr checks [PR_NUMBER]
# View PR in browser
gh pr view [PR_NUMBER] --web
# PR details
gh pr view [PR_NUMBER]
CI Result Template#
## CI/CD Status
| Check | Status | Duration |
|-------|--------|----------|
| Build (iOS) | â
| 5m 32s |
| Build (Android) | â
| 4m 18s |
| Test | â
| 2m 45s |
| Lint | â
| 0m 58s |
| Coverage | â ïļ 78% | - |
**Overall Status**: ðĄ Coverage below threshold (80%)
Template G: Commit Message Guide#
Format#
< type > ( < scope > ): < gitmoji > < description >
[optional body]
[optional footer]
Examples#
feat(auth): âĻ Add social login feature
Kakao, Naver, Google OAuth integration
- Token storage and refresh logic
- Auto-login feature
Closes #123
fix(home): ð Fix feed infinite scroll bug
Resolved duplicate API call issue when reaching scroll end
Fixes #456
refactor(store): âŧïļ Optimize product list query
Resolved N+1 query issue (30% performance improvement)
Types#
| Type | Description | Gitmoji |
|---|---|---|
| feat | New feature | âĻ |
| fix | Bug fix | ð |
| refactor | Refactoring | âŧïļ |
| test | Testing | â |
| docs | Documentation | ð |
| chore | Config/build | ð§ |
| style | Formatting | ðĻ |
| perf | Performance improvement | ⥠|