git-commit

Enforce Conventional Commits messages for staged code changes.

24|1|Updated Sep 15, 2023
One-click install
npx skills add https://github.com/j5ik2o/event-store-adapter-js --skill git-commit-j5ik2o
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit
Source: https://github.com/j5ik2o/event-store-adapter-js/tree/main/.agents/skills/git-commit
Command: npx skills add https://github.com/j5ik2o/event-store-adapter-js --skill git-commit-j5ik2o

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides users to commit changes in a clean, meaningful way following Conventional Commits guidelines, ensuring a traceable project history.

Core Features & Use Cases

  • Staged-first workflow: instructs staging changes in meaningful units before committing.
  • Conventional message construction: enforces type, scope, and concise description per Conventional Commits.
  • Safety and clarity: prevents including co-authors or agent names in messages to keep history clean for collaboration.

Quick Start

Stage the latest changes and commit them using a conventional message.

Frequently Asked Questions about git-commit

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

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

Conventional commit messages organize git history by enforcing a structured format with a type, scope, and concise description for every staged change. This ensures a traceable project history across features, bug fixes, and chores.

What is the best way to stage changes before committing in version control?

The best way to stage changes before committing is to group them into meaningful units. This staged-first workflow ensures that each conventional commit message accurately reflects a single, logical modification to the codebase.

Can I include co-authors or agent names in conventional commit messages?

No, conventional commit messages should exclude co-authors or agent names. Omitting these names keeps the version control history clean and prevents unnecessary clutter during team collaboration.

When do I need to use conventional commits in my development workflow?

You need to use conventional commits during everyday development workflows across projects whenever you stage changes. It is required for feature work, bug fixes, and chores to maintain a clean and traceable project history.

Does the conventional commit format require a specific structure for git commits?

Yes, the conventional commit format requires a specific structure. Every git commit message must include a type, an optional scope, and a concise description to properly organize code history and clarify the purpose of each change.