commit-writer

Automate git commits with conventional-commit messages from diffs and staging.

32|2|Updated Apr 19, 2023
One-click install
npx skills add https://github.com/pysan3/dotfiles --skill commit-writer-pysan3
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-writer
Source: https://github.com/pysan3/dotfiles/tree/main/config/claude/skills/commit-writer
Command: npx skills add https://github.com/pysan3/dotfiles --skill commit-writer-pysan3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates creating git commits with conventional-commit messages by analyzing diffs and staging decisions, reducing guesswork and improving consistency.

Core Features & Use Cases

  • Auto-detects type and scope from changes to compose conventional commits.
  • Generates human-readable commit messages from diffs and supports overrides for type, scope, and description.
  • Performs intelligent, logical file staging to group related changes and minimize churn.
  • Supports safe workflow practices by avoiding secrets exposure and enforcing pre-commit checks.

Quick Start

Tell commit-writer to prepare a conventional commit for the current changes.

Frequently Asked Questions about commit-writer

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

FAQPage Schema
How do I automate generating conventional commit messages from git diffs?

Automating conventional commit generation involves analyzing git diffs to auto-detect type and scope, then composing a human-readable message from the changes. It also performs intelligent file staging to group related changes safely.

What is the best way to group related file changes when staging a git commit?

The best way to group related file changes is through intelligent staging, which analyzes diffs to logically group related changes, minimize churn, and apply safety checks before finalizing the commit.

Can I override the auto-detected type and scope in a generated conventional commit?

Yes, you can override the auto-detected type, scope, and description interactively, allowing you to apply standardized conventional commits while retaining manual control over the final message.

How do conventional commit tools handle staging when secrets are present in the diff?

Conventional commit automation handles staging safely by avoiding secrets exposure and enforcing pre-commit checks, ensuring sensitive data detected in the diff is not inadvertently committed.

Do I need any external dependencies to automate staging and conventional commits?

No external dependencies are required to automate staging and conventional commits, as the automation operates independently by analyzing diffs and applying safety checks directly within your development workflow.