write-commit-message

Draft and validate VCS commit messages with enforced formatting rules.

Updated Jul 9, 2020
One-click install
npx skills add https://github.com/feosuna1/dotfiles --skill write-commit-message-feosuna1
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-commit-message
Source: https://github.com/feosuna1/dotfiles/tree/main/files/claude/skills/write-commit-message
Command: npx skills add https://github.com/feosuna1/dotfiles --skill write-commit-message-feosuna1

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Many commit messages are inconsistent, unclear, or malformed which makes git history hard to read and slows code review. This Skill ensures commit subjects and bodies follow established guidelines so changelogs and reviews remain useful and actionable.

Core Features & Use Cases

  • Enforces a 50-character subject limit, capitalization, imperative mood, and no trailing period.
  • Verifies a blank line after the subject and wraps body lines to 72 characters using a line-counting script, plus runs a lint script to detect structural violations.
  • Use Case: Prepare or amend a commit message for a pull request to ensure it is concise, explains why the change was needed, and passes automated checks before merging.

Quick Start

Use the write-commit-message skill to draft a subject and body, run the provided lint and count tools, and return the final lint-passing commit message.

Frequently Asked Questions about write-commit-message

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

FAQPage Schema
How do I enforce a 50-character subject limit and 72-character body wrapping for git commit messages?

To enforce git commit message formatting, this Skill drafts subjects under 50 characters and wraps body text at 72 characters using a line-counting script. It validates capitalization, imperative mood, and blank-line separation before finalizing commits.

What is the best way to automate commit message linting for VCS workflows like git, jj, and sapling?

Automating commit message linting involves running validation scripts that detect structural violations in version control systems. This Skill executes provided lint and count tools to verify formatting standards across git, jj, and sapling when creating or amending commits.

Does this commit message formatter require any external dependencies or linting tools installed?

No external dependencies are required to use this commit message formatter. The Skill operates independently using its built-in scripts and references to validate subject length, capitalization, imperative mood, and body wrapping without needing additional packages.

Why should commit message subjects use imperative mood and avoid trailing periods?

Commit message subjects use imperative mood and avoid trailing periods to follow established VCS guidelines, keeping git history readable and actionable. This formatting standard ensures changelogs and code reviews remain consistent and clear for all contributors.

How do I prepare a standards-compliant commit message for a pull request?

To prepare a standards-compliant commit message for a pull request, draft a concise subject and explanatory body, then run validation scripts. This Skill enforces formatting rules, executes lint checks, and returns a final lint-passing message ready for merging.