commit

Draft conventional git commit messages with type-prefixed subjects.

217|7|Updated Dec 9, 2024
One-click install
npx skills add https://github.com/shift-editor/shift --skill commit-shift-editor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/shift-editor/shift/tree/main/.claude/skills/commit
Command: npx skills add https://github.com/shift-editor/shift --skill commit-shift-editor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents messy git history by enforcing consistent, conventional commit messages that are easy to read and grep later.

Core Features & Use Cases

  • Conventional commit formatting: Forces every commit subject into the form <type>: <concise description> so git log --oneline stays readable.
  • Single logical change per commit: Encourages splitting unrelated changes into separate commits to keep history accurate and reviewable.
  • Practical drafting workflow: Prompts you for the “why” before drafting, then checks fit with type, subject rules, and when a body is needed.

Use case: You update the editor and also fix a crash caused by that UI change; you’ll end up with two commits like feat: ... and fix: ..., rather than one vague “misc changes” commit.

Quick Start

Ask the skill to draft commit messages for your proposed changes and to propose a split if multiple logical changes are present.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I write conventional commit messages for git?

Conventional commit messages follow the `<type>: <concise description>` format to keep git history readable. This skill drafts these messages by enforcing allowed types and formatting rules, reducing ambiguity in your version control workflow.

How do I split multiple logical changes into separate git commits?

To split changes into separate git commits, group unrelated modifications into distinct logical units before staging. This skill identifies when multiple logical changes are present and proposes a split, drafting individual messages for each.

When do I need a body in a conventional commit message?

A body is needed in a conventional commit message when the concise subject cannot fully explain the why behind the change. This skill prompts you for reasoning and checks whether the type and subject rules require a body.

What are the allowed types for conventional commits in version control?

Allowed types for conventional commits include features, fixes, refactors, and build or CI updates. This skill enforces these specific types in the commit subject to maintain a changelog-like history across code, test, docs, and tooling changes.

Does this commit message skill work for documentation and test changes?

Yes, this commit message skill works for documentation and test changes. It applies conventional commit formatting across code, tests, docs, and tooling updates, ensuring the entire repository workflow maintains a readable git log.