code-reviewer

Review local Git changes and GitHub pull requests for code quality.

Updated Oct 16, 2022
One-click install
npx skills add https://github.com/deferred/dotfiles --skill code-reviewer-deferred
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-reviewer
Source: https://github.com/deferred/dotfiles/tree/main/home/dot_agents/skills/code-reviewer
Command: npx skills add https://github.com/deferred/dotfiles --skill code-reviewer-deferred

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of reviewing code, ensuring correctness, maintainability, and adherence to project standards for both local changes and remote pull requests.

Core Features & Use Cases

  • Local Code Review: Analyze staged and unstaged changes in your local Git repository.
  • Remote Pull Request Review: Review code directly from GitHub Pull Requests by ID or URL.
  • Comprehensive Analysis: Evaluates code based on correctness, maintainability, readability, efficiency, security, and error handling.
  • Structured Feedback: Provides clear, constructive feedback with a summary, findings (critical, improvements, nitpicks), and a conclusion.

Quick Start

Use the code-reviewer skill to review my current local code changes.

Frequently Asked Questions about code-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review local Git changes for maintainability and security?

To review local Git changes, analyze your staged and unstaged modifications for maintainability, readability, efficiency, security, and error handling to ensure correctness and project standard adherence.

Can I review a GitHub pull request by URL or ID?

Yes, you can review a GitHub pull request by providing its specific ID or URL, which utilizes the GitHub CLI to checkout the code and run project-specific preflight checks for validation.

What does an automated code review analysis cover?

An automated code review analysis evaluates correctness, maintainability, readability, efficiency, security, and error handling, providing structured feedback with critical findings, improvements, nitpicks, and a conclusion.

Do I need the GitHub CLI to review remote pull requests?

Yes, the GitHub CLI is required for reviewing remote pull requests, as it handles the checkout process for the specified ID or URL and executes project-specific preflight checks for validation.

What is the best way to get structured feedback on code quality?

The best way to get structured feedback on code quality is to run an analysis that outputs a summary with critical findings, suggested improvements, nitpicks, and a final conclusion regarding your code changes.