claude-howto/05-skills/code-review/templates/finding-template.md

Code Review Finding Template

Use this template when documenting each issue found during code review.

---

Issue: [TITLE]

Severity

• Critical (blocks deployment)
• High (should fix before merge)
• Medium (should fix soon)
• Low (nice to have)

Category

• Security
• Performance
• Code Quality
• Maintainability
• Testing
• Design Pattern
• Documentation

Location

File: src/components/UserCard.tsx

Lines: 45-52

Function/Method: renderUserDetails()

Issue Description

What: Describe what the issue is.

Why it matters: Explain the impact and why this needs to be fixed.

Current behavior: Show the problematic code or behavior.

Expected behavior: Describe what should happen instead.

Code Example

Current (Problematic)

// Shows the N+1 query problem
const users = fetchUsers();
users.forEach(user => {
  const posts = fetchUserPosts(user.id); // Query per user!
  renderUserPosts(posts);
});

Suggested Fix

// Optimized with JOIN query
const usersWithPosts = fetchUsersWithPosts();
usersWithPosts.forEach(({ user, posts }) => {
  renderUserPosts(posts);
});

Impact Analysis

Aspect	Impact	Severity
Performance	100+ queries for 20 users	High
User Experience	Slow page load	High
Scalability	Breaks at scale	Critical
Maintainability	Hard to debug	Medium

Related Issues

• Similar issue in AdminUserList.tsx line 120
• Related PR: #456
• Related issue: #789

Additional Resources

• N+1 Query Problem
• Database Join Documentation
• Performance Optimization Guide

Reviewer Notes

• This is a common pattern in this codebase
• Consider adding this to the code style guide
• Might be worth creating a helper function

Author Response (for feedback)

To be filled by the code author:

• Fix implemented in commit: abc123
• Fix status: Complete / In Progress / Needs Discussion
• Questions or concerns: (describe)

---

Finding Statistics (for Reviewer)

When reviewing multiple findings, track:

• Total Issues Found: X
• Critical: X
• High: X
• Medium: X
• Low: X

Recommendation: ✅ Approve / ⚠️ Request Changes / 🔄 Needs Discussion

Overall Code Quality: 1-5 stars