commit

Creates Conventional Commits messages for staged git changes with AI co-authorship attribution.

15|22|Updated May 5, 2024
One-click install
npx skills add https://github.com/brayandiazc/project-starter-template-es-ai --skill commit-brayandiazc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/brayandiazc/project-starter-template-es-ai/tree/main/.claude/skills/commit
Command: npx skills add https://github.com/brayandiazc/project-starter-template-es-ai --skill commit-brayandiazc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, well-formatted commit messages that follow project conventions is tedious and error-prone. This Skill inspects your staged changes, applies your project's commit rules, and creates a properly formatted Conventional Commits message automatically. ## Core Features & Use Cases - Conventional Commits formatting: Generates messages in the <type>(<scope>): <subject> format with types like feat, fix, docs, refactor, test, and chore, including BREAKING CHANGE footers when needed. - Project convention awareness: Reads CONTRIBUTING.md to follow repository-specific rules for types, scopes, subject style, and required footers. - Pre-commit formatting: Runs the project's formatter (e.g., Prettier via .github/scripts/format.sh) on changed Markdown files before committing so CI checks pass. - AI attribution: Adds the Co-Authored-By trailer for AI-assisted work as defined by the project. - Use Case: After finishing a feature, stage your changes and ask for a commit; the Skill inspects the diff, formats files, writes a compliant message, and creates the commit without pushing. ## Quick Start Ask the assistant to commit the current staged changes with a proper Conventional Commits message.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I write a Conventional Commits message for staged changes?▼

Stage your changes with git add, then ask for a commit. The Skill inspects git status and git diff --staged, drafts a message in the <type>(<scope>): <subject> format, and creates the commit following your project's CONTRIBUTING.md rules.

How to make git commits follow project-specific conventions automatically?▼

The Skill reads CONTRIBUTING.md first to learn allowed types, scope conventions, subject style, and required footers, then applies those rules over its defaults when drafting the message for your staged changes.

Does this commit workflow push changes to the remote repository?▼

No, it only creates the local commit. It explicitly does not push, amend, or rewrite existing history, keeping each commit focused on related changes only.

What happens if nothing is staged when I ask for a commit?▼

The Skill checks git diff for unstaged changes and stages the appropriate files, asking you first when the selection is ambiguous. It will not include unrelated changes in the commit.

Why does the commit step run a formatter before committing?▼

CI enforces formatting, so when Markdown files are changed the Skill runs the project's Prettier script and re-stages any modified files. This prevents formatting failures from surfacing later in CI.