commit-workflow

Name: commit-workflow
Availability: InStock
Author: RetailCRM

Standardize commit messages using Conventional Commits and workspace folder scopes.

1|Updated Apr 23, 2024

Search Tags:#code review #commit #conventional commits #repository #commit scope

Ready to run

npx skills add https://github.com/retailcrm/embed-ui --skill commit-workflow-retailcrm

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-workflow
Source: https://github.com/retailcrm/embed-ui/tree/main/.agents/skills/commit-workflow
Command: npx skills add https://github.com/retailcrm/embed-ui --skill commit-workflow-retailcrm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that commits within the repository adhere to a consistent format, making it easier to review and manage changes.

Core Features & Use Cases

Commit Formatting: Enforces Conventional Commits for structured commit messages.
Scope Management: Helps in maintaining clear commit scopes based on workspace folders.
Validation: Validates commit format and language before finalizing.

Quick Start

Execute the skill by using the 'commit-workflow' command when creating or splitting commits.

Frequently Asked Questions about commit-workflow

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

FAQPage Schema

How do I standardize commit messages across my repository?▼

To standardize commit messages across your repository, this Skill enforces Conventional Commits formatting and validates commit scopes based on workspace folders before finalizing changes. It ensures English commit messages and specified commit types, facilitating easier code review and repository maintenance.

What are Conventional Commits and how do they structure repository changes?▼

Conventional Commits structure repository changes by enforcing a consistent commit message format with specified commit types and logical commit splitting. This standardization mechanism ensures commits use English messages and clear workspace folder scopes, making repository changes easier to review and maintain.

How do I maintain clear commit scopes based on workspace folders?▼

You maintain clear commit scopes based on workspace folders by using this Skill to validate and apply logical folder boundaries to your commit messages. It standardizes commit scopes across the repository, ensuring changes are categorized correctly to facilitate code review.

Can I use this commit workflow to split large changes into logical commits?▼

Yes, you can use this commit workflow to split large changes into logical commits. It enforces Conventional Commits formatting and validates the commit scope and language, ensuring each split commit adheres to repository consistency standards for easier maintenance.

Does this commit validation Skill require any external dependencies?▼

No, this commit validation Skill requires no external dependencies to standardize your repository commit messages. It operates independently using scripts to enforce Conventional Commits, workspace folder scopes, and English commit messages.