commit-convention

Name: commit-convention
Availability: InStock
Author: droidconKE

Generate commit subjects, branch names, and PR titles following Chai's conventions.

8|4|Updated Mar 9, 2023

Search Tags:#coding conventions #commit message #branch naming #commit automation #PR title

Ready to run

npx skills add https://github.com/droidconKE/chai --skill commit-convention-droidconke

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-convention
Source: https://github.com/droidconKE/chai/tree/main/.ai/skills/commit-convention
Command: npx skills add https://github.com/droidconKE/chai --skill commit-convention-droidconke

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of commit subjects, branch names, and PR titles that adhere to Chai's coding conventions, reducing the risk of non-compliance and streamlining the commit process.

Core Features & Use Cases

Automated Commit Formatting: Generates commit subjects, branch names, and PR titles that follow Chai's conventions.
Branch Naming: Creates branch names in the format feature/<slug>, fix/<slug>, or docs/<slug>.
PR Title Generation: Produces PR titles in the same style as commit subjects.
Use Case: Before committing or opening a pull request, use this Skill to ensure that your commit messages and branch names are correctly formatted.

Quick Start

Run the command 'commit-convention' to generate a commit subject, branch name, and PR title that match Chai's conventions.

Frequently Asked Questions about commit-convention

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

FAQPage Schema

How do I automate commit message formatting for coding conventions?▼

To automate commit message formatting, run the 'commit-convention' command to instantly generate compliant commit subjects, branch names, and PR titles that strictly adhere to Chai's coding conventions.

What is the correct branch naming convention for feature and bugfix branches?▼

The correct branch naming convention uses specific prefixes with slugs, generating branch names in the format 'feature/<slug>', 'fix/<slug>', or 'docs/<slug>' to maintain strict repository compliance.

How do I generate a PR title that matches my commit message format?▼

Generating a PR title that matches your commit message format is handled by the commit-convention automation, which produces PR titles in the exact same style and structure as the formatted commit subjects.

Does commit automation work for enforcing project-specific coding conventions?▼

Commit automation enforces project-specific coding conventions by automatically validating and generating the required text structures. This specific Skill targets Chai's commit message rules and PR title formatting.

Why do my automated commit messages fail the project's branch naming rules?▼

Automated commit messages fail branch naming rules when they deviate from required slugs and prefixes. This Skill prevents failures by automatically generating compliant 'feature/<slug>', 'fix/<slug>', or 'docs/<slug>' formats.