commit-message

Enforce conventional commit messages with type prefixes, subject, body, and file tree.

20|3|Updated Aug 16, 2016
One-click install
npx skills add https://github.com/heyJordanParker/dotfiles --skill commit-message-heyjordanparker
Or copy as Structured Prompt for Agentā–¼
Please help me install this Agent Skill.
Skill: commit-message
Source: https://github.com/heyJordanParker/dotfiles/tree/main/claude/.claude/skills/commit-message
Command: npx skills add https://github.com/heyJordanParker/dotfiles --skill commit-message-heyjordanparker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enforces a conventional commit message structure to improve readability and changelog clarity.

Core Features & Use Cases

  • Conventional commit style: enforce type prefixes like feat, fix, chore, refactor, docs, test.
  • What+Why body: include a rationale behind changes in the commit body.
  • File tree section: include an annotated project file tree for context in the message.
  • Use case: when collaborating on a project, this skill ensures every commit is easy to understand during reviews and history navigation.

Quick Start

Draft a new commit message following the template. For example: feat: add user login What changed + why: implemented OAuth2 login to enable SSO File tree app/ ā”œā”€ā”€ login/ │ └── Login.ts

Frequently Asked Questions about commit-message

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

FAQPage Schema
How do I write a conventional commit message with a type prefix?ā–¼

A conventional commit message requires a type prefix such as feat, fix, or chore, followed by a concise lowercase subject under 72 characters. This standardizes git history and improves readability during code reviews.

What should I include in the body of a git commit message?ā–¼

A git commit message body should include a what and why rationale behind the changes. Explaining what changed and why it was necessary ensures every commit is easy to understand when navigating project history.

Does this commit message template require an annotated file tree?ā–¼

Yes, the commit message template requires an annotated project file tree section. Including the file tree provides necessary context directly in the message, helping collaborators understand exactly which files were modified.

What is the character limit for a conventional commit subject line?ā–¼

The character limit for a conventional commit subject line is under 72 characters. Keeping the subject concise and lowercase ensures compatibility with standard git linting workflows and improves history readability.

When do I need to use conventional commits in my git workflow?ā–¼

You need to use conventional commits in your git workflow when collaborating on software projects to ensure standardized history. Enforcing this structure improves changelog clarity and makes commits easy to understand during reviews.

What are the valid type prefixes for conventional commit messages?ā–¼

Valid type prefixes for conventional commit messages include feat, fix, chore, refactor, docs, and test. Applying these prefixes categorizes changes consistently across the project's git history.