skills.rest
craigtkhill
craigtkhillCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

write-commit-message

Generate git commit messages following conventional commits syntax.

Updated Nov 17, 2025
Search Tags:#git#workflow#developer tools#version control#conventional commits#code history#commit message
One-click install
npx skills add https://github.com/craigtkhill/atui-tools --skill write-commit-message
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-commit-message
Source: https://github.com/craigtkhill/atui-tools/tree/main/skills/write-commit-message
Command: npx skills add https://github.com/craigtkhill/atui-tools --skill write-commit-message

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the guesswork and inconsistency in writing Git commit messages. It ensures every commit is clear, informative, and follows conventional standards, making your project's history easy to understand, maintain, and review, saving you time and frustration.

Core Features & Use Cases

  • Conventional Commits Guidance: Provides a clear template and rules for type, scope, description, body, and footers, standardizing your commit history.
  • Breaking Change Indication: Guides on how to properly mark and document breaking changes, ensuring critical information is never missed.
  • Best Practices Enforcement: Encourages imperative mood, concise descriptions, and logical commit units, improving readability and maintainability.
  • Use Case: After completing a feature or bug fix, use this skill to generate a perfectly formatted commit message, ensuring your project's Git history is clean, readable, and adheres to team standards, simplifying code reviews and future debugging.

Quick Start

You have just fixed a bug in the user authentication module. Use the write-commit-message skill to draft a commit message for this fix.

Frequently Asked Questions about write-commit-message

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

FAQPage Schema
How do I write a Git commit message that follows conventional commits format?▼

Conventional commits use a structured format with type, optional scope, description, optional body, and footers. Start with a type (fix, feat, docs, test, refactor), add a colon, then write an imperative-mood description under 72 characters. This standardizes your commit history across collaborative projects.

What is conventional commits and why should my team use it?▼

Conventional commits is a specification for formatting Git messages with consistent types and structure. Teams adopt it to make code history readable, automate versioning, simplify code reviews, and ensure critical changes like breaking updates are never missed in project records.

How do I indicate a breaking change in a Git commit message?▼

Add a breaking-change footer or append an exclamation mark before the colon in the type—for example, feat!: or feat(scope)!:. Then document the breaking change in the message body or footers so reviewers and future maintainers understand the impact.

Can I use conventional commits for documentation and refactoring commits, or just bug fixes?▼

Conventional commits apply to all change types: feat for features, fix for bugs, docs for documentation, test for tests, and refactor for code restructuring. Using it consistently across all commit types keeps your entire Git history standardized and searchable.

What's the difference between commit scope and description in conventional commits?▼

Scope (optional) narrows the change—like feat(auth) for authentication fixes. Description is the imperative statement of what changed, kept under 72 characters. The body adds detail; scope+description together make commits precise and filterable.

Why does conventional commits limit the description to 72 characters?▼

The 72-character limit ensures commit messages display cleanly in terminals, email clients, and Git log outputs without wrapping. This convention preserves readability across tools and makes first-line summaries scannable in project history.

Related Skills

Explore More Software Engineering Skills→
BSteffaniakBSteffaniak

commit-message-staged-write

Generate Git commit messages from staged changes and write them for commit tools.

Community
Intermediate
p-o-ke-naep-o-ke-nae

changelog-automation

Generate changelogs from commits, pull requests, and releases.

Community
Advanced
andymaiandymai
77

git-pr-workflow

Resolves Git workflow blockers for the brepjs repository.

Community
Advanced
dennisonbertramdennisonbertram
1

changelog-gen

Generate release notes from Git history using Conventional Commits and git-cliff.

Community
Advanced