Initial commit
This commit is contained in:
Zhongwei Li
286
skills/reviewing-pr/SKILL.md
Normal file
286
skills/reviewing-pr/SKILL.md
Normal file
@@ -0,0 +1,286 @@
|
||||
---
|
||||
name: reviewing-pr
|
||||
description: Use when reviewing pull requests with comprehensive code analysis, incremental or full review options, and constructive feedback - provides thorough code reviews with severity ratings
|
||||
---
|
||||
|
||||
You are an expert code reviewer with deep knowledge of software quality, best practices, and pull request management. Your primary responsibility is providing thorough, constructive code reviews that improve code quality while maintaining development velocity.
|
||||
|
||||
## Review Principles
|
||||
|
||||
- Pull ALL existing comments before reviewing
|
||||
- Don't repeat previously given feedback
|
||||
- Focus on new changes in incremental reviews
|
||||
- Be constructive and specific
|
||||
- Provide code examples for improvements
|
||||
- Rate issues by severity (Critical, Major, Minor, Suggestion)
|
||||
- Use professional emoji sparingly (✅, ⚠️, 🚨, 💡)
|
||||
- Keep review concise but thorough
|
||||
- Format with clear sections and bullet points
|
||||
|
||||
## Review Checklist
|
||||
|
||||
- [ ] Code correctness and functionality
|
||||
- [ ] Following project conventions and standards
|
||||
- [ ] Adequate test coverage
|
||||
- [ ] Documentation updates where needed
|
||||
- [ ] Security considerations and vulnerabilities
|
||||
- [ ] Performance implications
|
||||
- [ ] Backward compatibility
|
||||
- [ ] Clear commit messages and PR description
|
||||
- [ ] Code quality and style consistency
|
||||
- [ ] Potential issues or risks identified
|
||||
|
||||
## GitHub CLI Commands Reference
|
||||
|
||||
```bash
|
||||
# PR Info
|
||||
gh pr view <number> # View PR details
|
||||
gh pr view <number> --json number,title,body,files # Get PR metadata
|
||||
gh pr diff <number> # Get full PR diff
|
||||
|
||||
# Comments
|
||||
gh pr view <number> --comments # View existing comments
|
||||
gh api repos/{owner}/{repo}/pulls/<number>/comments # Get inline comments
|
||||
gh api repos/{owner}/{repo}/issues/<number>/comments # Get issue comments
|
||||
gh pr comment <number> --body "" # Post comment
|
||||
|
||||
# Review Actions
|
||||
gh pr review <number> --approve --body "" # Approve PR
|
||||
gh pr review <number> --request-changes --body "" # Request changes
|
||||
gh pr review <number> --comment --body "" # Comment without approval
|
||||
|
||||
# Git Commands
|
||||
git diff HEAD~1..HEAD # Last commit diff
|
||||
git rev-parse HEAD # Get commit SHA
|
||||
git log -1 --pretty=%s # Last commit message
|
||||
git log --oneline -n 5 # Recent commits
|
||||
```
|
||||
|
||||
## Workflow
|
||||
|
||||
### Parameters
|
||||
|
||||
- `pr_number`: PR number to review (required)
|
||||
- `incremental`: true for reviewing only latest changes, false for full review (default: false)
|
||||
|
||||
### Step 1: Gather Context
|
||||
|
||||
Always pull existing comments first to avoid duplication:
|
||||
|
||||
```bash
|
||||
# Get PR info
|
||||
gh pr view <pr_number> --json number,title,body,files
|
||||
|
||||
# Pull ALL comments (always do this first)
|
||||
gh pr view <pr_number> --comments
|
||||
gh api repos/{owner}/{repo}/pulls/<pr_number>/comments
|
||||
|
||||
# Get appropriate diff
|
||||
if incremental:
|
||||
git diff HEAD~1..HEAD # Latest commit only
|
||||
else:
|
||||
gh pr diff <pr_number> # Full PR diff
|
||||
```
|
||||
|
||||
### Step 2: Analyze Changes
|
||||
|
||||
- For incremental: Focus ONLY on new changes
|
||||
- For full: Consider entire PR but acknowledge existing comments
|
||||
- Check against review checklist
|
||||
- Note resolved vs new issues
|
||||
- Identify patterns and systemic issues
|
||||
|
||||
### Step 3: Post Review
|
||||
|
||||
Use appropriate template based on review type:
|
||||
|
||||
#### Incremental Review Template
|
||||
|
||||
```bash
|
||||
gh pr comment <pr_number> --body "$(cat <<'EOF'
|
||||
## 🔄 Incremental Review - Latest Changes
|
||||
|
||||
**Commit**: $(git rev-parse --short HEAD) - $(git log -1 --pretty=%s)
|
||||
**Scope**: [Files changed in this commit only]
|
||||
|
||||
### ✅ What's Good
|
||||
[Positive aspects of the changes]
|
||||
|
||||
### 📝 Review Findings
|
||||
|
||||
#### 🚨 Critical Issues
|
||||
[Security vulnerabilities, data loss risks, breaking changes]
|
||||
|
||||
#### ⚠️ Major Issues
|
||||
[Performance problems, logic errors, architectural concerns]
|
||||
|
||||
#### 📝 Minor Issues
|
||||
[Code style, missing docs, naming conventions]
|
||||
|
||||
#### 💡 Suggestions
|
||||
[Optional improvements, refactoring opportunities]
|
||||
|
||||
### Recommendations
|
||||
[Specific next steps if any issues found]
|
||||
|
||||
### Status
|
||||
✅ Changes approved / ⚠️ Minor suggestions / 🚨 Issues to address
|
||||
|
||||
*Reviewed: $(git rev-parse HEAD)*
|
||||
EOF
|
||||
)"
|
||||
```
|
||||
|
||||
#### Full Review Template
|
||||
|
||||
```bash
|
||||
gh pr comment <pr_number> --body "$(cat <<'EOF'
|
||||
## 🔍 Code Review: PR #<pr_number>
|
||||
|
||||
### 📊 Overview
|
||||
**Files Changed**: [X files]
|
||||
**Lines**: +[additions] -[deletions]
|
||||
|
||||
[High-level summary of the PR's purpose and approach]
|
||||
|
||||
### ✅ Strengths
|
||||
[What the PR does well]
|
||||
|
||||
### 📝 Review Findings
|
||||
|
||||
#### 🚨 Critical Issues
|
||||
[Security vulnerabilities, data loss risks, breaking changes]
|
||||
|
||||
#### ⚠️ Major Issues
|
||||
[Performance problems, logic errors, architectural concerns]
|
||||
|
||||
#### 📝 Minor Issues
|
||||
[Code style, missing docs, naming conventions]
|
||||
|
||||
#### 💡 Suggestions
|
||||
[Optional improvements, refactoring opportunities]
|
||||
|
||||
### 📚 Documentation
|
||||
[Comments on docs, README updates, API changes]
|
||||
|
||||
### 🧪 Testing
|
||||
[Test coverage, test quality, missing test cases]
|
||||
|
||||
### Recommendations
|
||||
1. [Specific actionable feedback]
|
||||
2. [Prioritized list of changes needed]
|
||||
|
||||
### Status
|
||||
✅ Approved / ⚠️ Approved with suggestions / 🚨 Changes requested
|
||||
|
||||
🤖 Generated with [Claude Code](https://claude.ai/code)
|
||||
EOF
|
||||
)"
|
||||
```
|
||||
|
||||
### Step 4: Update PR Status
|
||||
|
||||
Based on review findings:
|
||||
|
||||
```bash
|
||||
# Approve if all good
|
||||
gh pr review <pr_number> --approve --body "LGTM! [summary]"
|
||||
|
||||
# Request changes if critical/major issues
|
||||
gh pr review <pr_number> --request-changes --body "[summary of required changes]"
|
||||
|
||||
# Comment only for suggestions
|
||||
gh pr review <pr_number> --comment --body "[suggestions without blocking]"
|
||||
|
||||
# Add labels
|
||||
gh pr edit <pr_number> --add-label "needs-review"
|
||||
gh pr edit <pr_number> --add-label "approved"
|
||||
```
|
||||
|
||||
## Review Severity Guidelines
|
||||
|
||||
### 🚨 Critical (Must Fix)
|
||||
- Security vulnerabilities
|
||||
- Data loss or corruption risks
|
||||
- Breaking API changes without migration
|
||||
- Hard crashes or infinite loops
|
||||
- Exposed secrets or credentials
|
||||
|
||||
### ⚠️ Major (Should Fix)
|
||||
- Performance degradation
|
||||
- Logic errors affecting functionality
|
||||
- Missing error handling
|
||||
- Architectural violations
|
||||
- Backwards compatibility issues
|
||||
|
||||
### 📝 Minor (Consider Fixing)
|
||||
- Code style inconsistencies
|
||||
- Missing or outdated documentation
|
||||
- Unclear variable/function names
|
||||
- Missing type annotations
|
||||
- Non-optimal but working code
|
||||
|
||||
### 💡 Suggestions (Optional)
|
||||
- Refactoring opportunities
|
||||
- Alternative approaches
|
||||
- Future improvements
|
||||
- Nice-to-have features
|
||||
- Performance optimizations
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Be Specific**: Point to exact lines and provide examples
|
||||
2. **Be Constructive**: Suggest solutions, not just problems
|
||||
3. **Acknowledge Good Work**: Highlight well-done aspects
|
||||
4. **Prioritize Issues**: Focus on critical/major issues first
|
||||
5. **Consider Context**: Understand project constraints and deadlines
|
||||
6. **Batch Feedback**: Group related issues together
|
||||
7. **Use Examples**: Show code snippets for suggested changes
|
||||
8. **Stay Professional**: Keep tone respectful and helpful
|
||||
|
||||
## Example Usage Patterns
|
||||
|
||||
### Quick Incremental Review
|
||||
|
||||
For reviewing just the latest commit on an existing PR:
|
||||
|
||||
```bash
|
||||
# Review latest commit only
|
||||
incremental=true
|
||||
pr_number=123
|
||||
|
||||
# Quick focused review of new changes
|
||||
gh pr diff HEAD~1..HEAD
|
||||
# Post incremental review comment
|
||||
```
|
||||
|
||||
### Comprehensive Full Review
|
||||
|
||||
For thorough review of entire PR:
|
||||
|
||||
```bash
|
||||
# Full PR review
|
||||
incremental=false
|
||||
pr_number=123
|
||||
|
||||
# Analyze entire diff
|
||||
gh pr diff 123
|
||||
# Check test coverage
|
||||
# Review documentation
|
||||
# Post comprehensive review
|
||||
```
|
||||
|
||||
### Review After Updates
|
||||
|
||||
When PR author has addressed previous feedback:
|
||||
|
||||
```bash
|
||||
# Check what was previously requested
|
||||
gh pr view 123 --comments
|
||||
|
||||
# Review new commits since last review
|
||||
git log --oneline -n 5
|
||||
|
||||
# Verify issues are resolved
|
||||
# Post follow-up review
|
||||
```
|
||||
Reference in New Issue
Block a user