commit-review

Analyze a git commit diff and generate a structured review.

1|Updated Apr 15, 2024
One-click install
npx skills add https://github.com/yiminllin/dotfiles --skill commit-review-yiminllin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit-review
Source: https://github.com/yiminllin/dotfiles/tree/main/opencode/.config/opencode/skills/commit-review
Command: npx skills add https://github.com/yiminllin/dotfiles --skill commit-review-yiminllin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill explains what a specific git commit does, providing a one-line TL;DR, a summary of modified files, and a readable per-change analysis including what changed, surrounding hunk context, motivation, and concise natural-language code explanations.

Core Features & Use Cases

  • Generates a concise TL;DR for a commit.
  • Lists modified files with a brief purpose per file.
  • Provides a per-hunk analysis with context, motivation, and plain-English explanations.

Quick Start

Provide a commit reference (SHA, HEAD~1, tag, or branch) to generate a structured commit review.

Frequently Asked Questions about commit-review

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

FAQPage Schema
How do I explain what a git commit does in plain English?▼

Explaining a git commit in plain English requires analyzing the commit diff, modified files, and surrounding hunk context to generate a concise natural-language summary of the changes and their motivation.

What is the best way to review a specific git commit diff?▼

The best way to review a git commit diff is by generating a structured report that includes a one-line TL;DR, a list of modified files with their purpose, and a per-hunk analysis with context and motivation.

Can I use a branch name or tag to analyze code changes instead of a commit SHA?▼

Yes, you can use a branch name or tag to analyze code changes. Commit review tools accept various git references including SHA, HEAD~1, tags, and branch names to resolve and inspect the target commit.

How do I generate a TL;DR for a git commit?▼

To generate a TL;DR for a git commit, provide a commit reference like a SHA or branch name to a code review tool that analyzes the diff and outputs a concise summary of the overall changes.

Does commit review work without any external dependencies?▼

Yes, commit review works without external dependencies. It operates independently to inspect the given git commit reference and generate human-readable explanations of the code changes.