conventional-commit

Generate commitlint-compliant conventional commit messages from staged diffs.

1|Updated Jan 13, 2023

Search Tags:#git #commit #commitlint #diff #staged-changes #conventional-commit

Ready to run

npx skills add https://github.com/theodrosyimer/.dotfiles --skill conventional-commit-theodrosyimer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/theodrosyimer/.dotfiles/tree/main/claude/skills/dev__conventional-commit
Command: npx skills add https://github.com/theodrosyimer/.dotfiles --skill conventional-commit-theodrosyimer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, rg, and includes scripts (resource) components.

What problem does it solve?

Developers often struggle to write consistent, high-quality commit messages that accurately describe code changes. This skill automates the process by generating conventional commit messages from the current staged diffs, aligning with project standards and improving history readability.

Core Features & Use Cases

Conventional commit generation: Create standardized commit messages from the changes in the staging area.
Diff-driven classification: Infer the appropriate type (feat, fix, docs, style, refactor, test, or chore) based on the changes.
Workflow automation: After user confirmation, stage and commit the generated message to streamline releases and reviews.

Quick Start

Generate a conventional commit message from the staged changes and apply it after your confirmation.

Frequently Asked Questions about conventional-commit

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

FAQPage Schema

How do I generate a conventional commit message from staged diffs?▼

A conventional commit message is generated by parsing staged diffs to infer the correct type, such as feat or fix, and formatting a commitlint-compliant message for your confirmation before applying it to the current branch.

Can I automatically infer the commit type from git staged changes?▼

Yes, the skill automatically infers the commit type from git staged changes by analyzing the diff content and classifying it as feat, fix, docs, style, refactor, test, or chore.

Does this conventional commit generator ensure commitlint compliance?▼

Yes, this conventional commit generator ensures commitlint compliance by formatting the inferred message to align with project standards, guaranteeing the resulting commit message passes commitlint validation before staging.

Do I need jq and rg installed to generate commit messages from diffs?▼

Yes, you need jq and rg installed. The skill relies on these dependencies to parse staged diffs and process the data required to generate your conventional commit message.

What is the best way to automate writing git commit messages for code reviews?▼

The best way to automate writing git commit messages for code reviews is using a diff-driven generator. This skill turns staged diffs into standardized conventional commits, streamlining releases and improving history readability.

How do I apply a generated conventional commit message to my current branch?▼

To apply a generated conventional commit message to your current branch, simply confirm the suggested message during the workflow. The skill then stages and commits the changes directly to your current branch.