commit-guidelines

Analyze code changes and create Conventional Commits messages and branch names.

5|Updated Jan 21, 2011
One-click install
npx skills add https://github.com/minusfive/dot --skill commit-guidelines-minusfive
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-guidelines
Source: https://github.com/minusfive/dot/tree/main/.claude/skills/commit-guidelines
Command: npx skills add https://github.com/minusfive/dot --skill commit-guidelines-minusfive

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all code commits and branch creations adhere to established standards, improving code quality and maintainability.

Core Features & Use Cases

  • Conventional Commits: Enforces the Conventional Commits specification for commit messages.
  • Branch Naming: Generates concise and descriptive branch names.
  • Change Analysis: Guides the analysis of code changes to determine appropriate commit types and scopes.
  • Use Case: Before committing a new feature, use this Skill to ensure your commit message follows the feat(auth): add user login format and that the branch name is descriptive like feat/user-login.

Quick Start

Use the commit-guidelines skill to analyze the changes and create a commit message.

Frequently Asked Questions about commit-guidelines

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

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

To write conventional commit messages, analyze code changes to determine the type and scope, then format the message like `feat(auth): add user login` to ensure adherence to established version control standards.

How do I generate concise and descriptive git branch names?

To generate descriptive git branch names, analyze the intended code changes and create a name reflecting the feature, such as `feat/user-login`, ensuring branch creation adheres to project naming standards.

What is the conventional commits format for code review submissions?

The conventional commits format for code review requires a type, optional scope, and description, like `feat(auth): add user login`, ensuring standard version control operations and improved code maintainability.

Does the commitlintrc ruleset enforce conventional commits analysis before committing?

Yes, committing requires adherence to `.commitlintrc.ts` rules and security analysis, ensuring all code changes and branch creations follow the enforced conventional commits specification.

Why do I need to analyze code changes before creating a conventional commit?

Analyzing code changes before creating a conventional commit is needed to determine the appropriate commit types and scopes, ensuring the commit message accurately describes the update for code review.