aj-geddes/code-review-analysis

Code Review Analysis

Table of Contents

• Overview
• When to Use
• Quick Start
• Reference Guides
• Best Practices

Overview

Systematic code review process covering code quality, security, performance, maintainability, and best practices following industry standards.

When to Use

• Reviewing pull requests and merge requests
• Analyzing code quality before merging
• Identifying security vulnerabilities
• Providing constructive feedback to developers
• Ensuring coding standards compliance
• Mentoring through code review

Quick Start

Minimal working example:

# Check the changes
git diff main...feature-branch

# Review file changes
git diff --stat main...feature-branch

# Check commit history
git log main...feature-branch --oneline

Reference Guides

Detailed implementations in the references/ directory:

| Guide | Contents | |---|---| | Initial Assessment | Initial Assessment | | Code Quality Analysis | Code Quality Analysis | | Security Review | Security Review | | Performance Review | Performance Review | | Testing Review | Testing Review | | Best Practices | Best Practices |

Best Practices

✅ DO

• Be constructive and respectful
• Explain the "why" behind suggestions
• Provide code examples
• Ask questions if unclear
• Acknowledge good practices
• Focus on important issues
• Consider the context
• Offer to pair program on complex issues

❌ DON'T

• Be overly critical or personal
• Nitpick minor style issues (use automated tools)
• Block on subjective preferences
• Review too many changes at once (>400 lines)
• Forget to check tests
• Ignore security implications
• Rush the review