go-code-review

Go Code Review

Automated PR code review for Go projects. Provides first-pass review with inline comments, quality scoring, and breaking change detection.

What It Does

1. Analyzes PR diff for code quality issues
2. Generates inline comments on specific lines
3. Produces a quality score (0-100)
4. Flags breaking API changes
5. Summarizes findings with actionable next steps

Steps

API Integration (Optional)

If GOPHER_GUIDES_API_KEY is set, verify it:

curl -s -H "Authorization: Bearer $GOPHER_GUIDES_API_KEY" \
  https://gopherguides.com/api/gopher-ai/me

If not set, local analysis tools (go vet, staticcheck, golangci-lint) still provide comprehensive analysis. Set the key for enhanced API-powered insights. Get your key at gopherguides.com.

1. Get the Diff

# For a PR
gh pr diff {number}

# For uncommitted changes
git diff

# For staged changes
git diff --cached

# For changes against main
git diff main...HEAD

2. Static Analysis on Changed Files

# Get list of changed Go files
CHANGED=$(git diff --name-only main...HEAD | grep '\.go$')

# Run vet on changed packages
echo "$CHANGED" | xargs -I{} dirname {} | sort -u | xargs go vet

# Run staticcheck on changed packages
echo "$CHANGED" | xargs -I{} dirname {} | sort -u | xargs staticcheck

# Run tests on affected packages
echo "$CHANGED" | xargs -I{} dirname {} | sort -u | xargs go test -race -count=1

3. Review Checklist

For each changed file, check:

Correctness

• Error handling on all fallible operations
• No nil pointer dereferences
• Proper resource cleanup (defer Close)
• Context propagation in concurrent code
• No data races (channels/mutexes used correctly)

Readability

• Clear naming following Go conventions
• Functions are focused (single responsibility)
• Comments explain "why", not "what"
• No magic numbers/strings

Maintainability

• Tests added/updated for changes
• No dead code introduced
• Dependencies justified
• Backward compatibility preserved (or breaking change documented)