conventional-commit

Generate conventional commit messages using an XML structure with type, scope, and description.

Updated May 10, 2024

Search Tags:#git #workflow #validation #xml #prompting #commit-message #conventional-commits

Ready to run

npx skills add https://github.com/asubota/lets --skill conventional-commit-asubota

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/asubota/lets/tree/main/.agents/skills/conventional-commit
Command: npx skills add https://github.com/asubota/lets --skill conventional-commit-asubota

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams consistently craft descriptive commit messages aligned with the Conventional Commits spec, reducing ambiguity and review effort.

Core Features & Use Cases

Structured templates: Provides a formal XML structure for commit messages to ensure consistency across the repository.
Validation guidance: Includes rules and examples to enforce proper types, scopes, and descriptions.
Workflow support: Walks users through status checks, staging, and finalizing commits with a repeatable process.

Quick Start

Generate a conventional commit message for a change using the provided XML commit-message template and guidelines.

Frequently Asked Questions about conventional-commit

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

FAQPage Schema

How do I generate conventional commit messages for git changes?▼

To generate conventional commit messages, this Skill applies an XML-guided template to your git changes, mapping them to the correct type, scope, and description to standardize your repository's version history.

What is the conventional commits specification for structuring git history?▼

The conventional commits specification standardizes git history by enforcing a structured format for commit messages, using defined types like features, fixes, docs, and chores to improve readability and traceability across repositories.

How do I validate my commit message against the conventional commits rules?▼

You validate your commit message by checking it against the provided XML structure and validation guidance, ensuring it includes the required type, scope, and description fields along with any optional body or footer.

Can I use this XML commit-message template for chore and documentation changes?▼

Yes, the XML commit-message template works across all repository changes, supporting standard types such as docs and chores to maintain consistency and reduce ambiguity in your git workflow.

What is the best way to standardize git commit messages for team review?▼

The best way to standardize team commit messages is to enforce a structured XML template with validation rules, ensuring every commit includes clear types and scopes to reduce ambiguity and review effort.