commit-review

Generate conventional commit messages from staged and unstaged code changes.

88|9|Updated Jul 16, 2020
One-click install
npx skills add https://github.com/docs-plus/docs.plus --skill commit-review-docs-plus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-review
Source: https://github.com/docs-plus/docs.plus/tree/main/.cursor/skills/commit-review
Command: npx skills add https://github.com/docs-plus/docs.plus --skill commit-review-docs-plus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing consistent, repository-compliant commit messages is time-consuming and error-prone, especially on teams with custom commitlint rules or complex monorepo structures. This skill eliminates manual guesswork and ensures your git history is clean, searchable, and aligned with team standards.

Core Features & Use Cases

  • Convention Detection: Automatically scans the repository for commitlint config, existing git log patterns, and custom commit shapes to match local standards exactly.
  • Intent-Based Grouping: Organizes staged and unstaged changes into atomic, revertable commits based on the purpose of the edits, not just file paths.
  • Context-Aware Review: For larger or older branches, it pulls relevant session context to understand the "why" behind changes, avoiding vague or misleading commit messages.
  • Use Case: A developer finishing a 3-day feature branch can get perfectly formatted, compliant commit messages for all their changes in seconds, with no risk of violating repo hook rules.

Quick Start

Request a review of your current staged and unstaged code changes and ask the AI to generate production-ready conventional commit messages for each logical group of edits.

Frequently Asked Questions about commit-review

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

FAQPage Schema
How do I generate conventional commit messages from staged and unstaged git changes?

You can generate conventional commit messages by requesting a review of your current staged and unstaged code changes, which automatically groups edits into atomic, revertable commits based on their intent. This ensures your git history is clean and searchable.

How does commit message generation work with custom commitlint rules?

Commit message generation with custom commitlint rules works by automatically scanning your repository for commitlint config, existing git log patterns, and custom commit shapes. This ensures generated messages match your local standards exactly without manual guesswork.

Can I use automated commit messages for a monorepo with complex codebases?

Yes, automated commit messages support monorepo and single-app codebases by organizing changes into atomic, revertable commits based on the purpose of edits. It applies custom commit conventions and excludes sensitive files from proposals across complex structures.

What is the best way to group code changes into atomic commits for pull requests?

The best way to group code changes into atomic commits is through intent-based grouping, which organizes staged and unstaged edits by their purpose rather than file paths. This produces production-grade conventional commits perfectly formatted for pull requests.

How do I avoid vague commit messages on a large feature branch?

To avoid vague commit messages on a large feature branch, the review process pulls relevant session context to understand the reasoning behind changes. This context-aware approach ensures your git history avoids misleading or uninformative entries for older branches.

Do I need to manually exclude sensitive files when generating git commit messages?

No, you do not need to manually exclude sensitive files when generating git commit messages. The automated review process inherently handles the exclusion of sensitive files from commit proposals, ensuring secure and compliant repository updates.