lxgicstudios/ai-diff-summary

Overview

This skill summarizes git diffs in clear, plain English designed for PR descriptions and faster code reviews. It turns staged changes, commits, or branch comparisons into human-readable summaries that explain intent and impact, not just line changes.

How this skill works

The tool reads git diffs or specific commits and uses AI to group related edits, describe what the code now does, and flag potential breaking changes. It supports staged changes, commit ranges, and branch comparisons, and can format output as a ready-to-use PR description.

When to use it

• Preparing a pull request and you need a concise description of changes
• Reviewing a complex diff to understand intent and impact quickly
• Documenting a commit or release notes with human-friendly language
• Checking for breaking changes before merging or deploying
• Comparing feature branches to summarize functional differences

Best practices

• Run the tool from the repository root with Node.js 18+ and OPENAI_API_KEY set
• Summarize staged changes before creating a PR to save reviewers time
• Use commit or branch flags to focus the summary on a specific scope
• Combine AI summary with manual review for security-sensitive or logic-critical changes
• Treat the summary as a starting point and edit the PR description for context and policy

Example use cases

• Generate a PR description automatically for a feature branch
• Summarize a single commit for changelog entries
• Compare main and feature branches to outline added or removed functionality
• Scan diffs to highlight potential breaking API changes before release
• Provide reviewers with grouped change lists (features, refactors, docs, tests)