commit

Generates Conventional Commits messages from local change status and diff tools.

4|1|Updated Jul 23, 2020
One-click install
npx skills add https://github.com/onbjerg/dot --skill commit-onbjerg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/onbjerg/dot/tree/main/pi/skills/commit
Command: npx skills add https://github.com/onbjerg/dot --skill commit-onbjerg

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill simplifies the process of creating well-structured, meaningful commit messages aligned with Conventional Commits standards, promoting clearer project history and easier collaboration.

Core Features & Use Cases

  • Commit Message Formatting: Guides users to write commit messages with type, scope, and summary.
  • Instructional Support: Provides detailed instructions on how to craft compliant commit messages and include files selectively.
  • Use Case: A developer wants to quickly generate a descriptive commit message for recent changes using a specific format without pushing them immediately.

Quick Start

Use the commit skill to create a well-structured commit message based on your current changes and instructions.

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 version control?

To write conventional commit messages, structure your git commits with a specific type, scope, and summary. This standardizes version control history by clarifying the nature and context of each change for better project tracking.

What is the conventional commits format and when should I use it?

The conventional commits format structures commit messages with a type, optional scope, and descriptive summary. Use it to automate changelog generation, simplify version control history analysis, and improve team collaboration clarity.

How do I generate a commit message from local git changes without pushing?

You can generate a commit message without pushing by analyzing local change status and diff outputs. This isolates message creation from remote synchronization, allowing selective file inclusion and detailed commit content control.

Can I selectively include files when creating conventional commit messages?

Yes, you can selectively include files when creating conventional commit messages. The process relies on local change status to inform message creation, allowing detailed control over exactly which files are involved in the commit.

Does this commit message formatter support automated changelog generation?

This commit message formatter supports automated changelog generation by adhering to Conventional Commits standards. Structuring messages with type and scope makes version control history parseable for automated semantic version bumping tools.

What's the best way to maintain consistency in git version control history?

The best way to maintain consistency in git version control history is formatting commit messages with standardized types and scopes. This ensures clarity across project contributions and simplifies tracking version control changes over time.