commit

Stage and commit code changes following the Conventional Commits specification.

Updated Aug 15, 2024
One-click install
npx skills add https://github.com/cdcoonce/Portfolio_Website --skill commit-cdcoonce
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/cdcoonce/Portfolio_Website/tree/main/.claude/skills/commit
Command: npx skills add https://github.com/cdcoonce/Portfolio_Website --skill commit-cdcoonce

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all code commits adhere to the Conventional Commits specification, leading to cleaner, more understandable, and easily automated Git history.

Core Features & Use Cases

  • Enforces Conventional Commits: Guides users to create commit messages with specific types (feat, fix, chore, etc.) and optional scopes.
  • Atomic Commits: Promotes single, logical changes per commit for better traceability and easier reverts.
  • Use Case: When you've finished implementing a new user authentication feature, use this Skill to stage your changes and generate a commit message like feat(auth): implement user login endpoint.

Quick Start

Use the commit skill to stage all changes and create a commit with the message 'fix: resolve issue with user login'.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I automate git commits to follow conventional commits formatting?

You can automate conventional commits formatting by staging changes and generating messages with specific types like feat or fix, optionally adding scopes. This enforces atomic commits for better project maintainability and cleaner Git history.

Why use atomic commits in version control workflows?

Atomic commits isolate single logical changes per commit, ensuring better traceability and easier reverts. This practice improves overall project maintainability by keeping the Git history clean and understandable.

What's the best way to enforce conventional commits type and scope conventions?

To enforce conventional commits type and scope conventions, automate the staging and committing process to guide users in creating properly formatted messages. This improves code workflow and ensures adherence to project standards.

Do I need any specific Git extensions to manage conventional commit workflows?

No specific Git extensions are required to manage conventional commit workflows. The process integrates directly with Git to manage version control workflows, requiring no additional dependencies to stage changes and enforce proper message formatting.

Can I stage all code changes and specify a custom conventional commit message?

Yes, you can stage all code changes and specify a custom conventional commit message. The workflow accepts direct input like 'fix: resolve issue with user login' to stage files and create the commit immediately.