commit

Create git commits with structured Problem and Solution messages.

1|Updated May 13, 2018
One-click install
npx skills add https://github.com/hujw77/dotfiles --skill commit-hujw77
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/hujw77/dotfiles/tree/main/home/.config/claude/skills/commit
Command: npx skills add https://github.com/hujw77/dotfiles --skill commit-hujw77

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a disciplined workflow for committing changes by enforcing a structured commit message format and safe branch handling, reducing ambiguity and drift in version history.

Core Features & Use Cases

  • Branch Handling: If on main or master, create a new branch with the echo/ prefix (e.g., echo/fix-aws-rate-limit); If already on a feature branch, proceed with commit.
  • Commit Message Format: Enforces a short title and a two-part body (Problem and Solution) to improve traceability and review efficiency.
  • Guidelines: Do not include test changes in the description; Git add ALL files related to the change; Write clearly and avoid unnecessary complexity.

Quick Start

Ask me to commit your current changes with a concise title and a Problem/Solution body, creating an echo/ branch if you are on main or master.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I write a structured git commit message with Problem and Solution sections?

A structured git commit message requires a short title prefix and a two-part body detailing the Problem and Solution. This format improves traceability and review efficiency by clearly separating the issue addressed from the fix applied.

How do I commit changes to a new branch instead of main automatically?

To commit changes safely, the workflow checks your current branch and creates a new echo/ prefixed branch if you are on main or master. This prevents direct commits to protected branches and ensures changes are isolated for review.

What is the best way to ensure all related files are included in a git commit?

The best way to include all related files is to use git add for every file associated with your change before committing. This ensures complete file coverage and prevents partial commits that could break the version history.

Should I include test changes in the git commit message description?

No, you should not include test changes in the git commit message description. Commit guidelines recommend writing clearly and avoiding unnecessary complexity by excluding test details from the Problem and Solution body.

Can I use this workflow to create a changelog entry across different branches?

Yes, you can use this workflow to create a changelog entry across different branches. It automates well-formed commits with structured messages and enforces branch-handling rules, ensuring consistent history regardless of the active branch.

What limitations exist when automating git commits with a structured message format?

A limitation of automating git commits with a structured message is the strict enforcement of a two-part Problem and Solution body. This rigid format may not suit trivial changes and requires all related files to be added manually.