commits

Generate commit messages following the Conventional Commits specification.

8.7k|482|Updated Jul 30, 2021
One-click install
npx skills add https://github.com/redis/RedisInsight --skill commits-redis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commits
Source: https://github.com/redis/RedisInsight/tree/main/.ai/skills/commits
Command: npx skills add https://github.com/redis/RedisInsight --skill commits-redis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you produce consistent, readable commit messages that make project history easier to understand and automate release tooling.

Core Features & Use Cases

  • Conventional Commits formatting: Enforces a structured pattern of <type>(<scope>): <subject> plus optional body and footer for issue references.
  • Type guidance and examples: Helps you choose the right commit type (e.g., feat, fix, refactor, test) and write an appropriate subject and explanation.
  • Best-practice guardrails: Encourages atomic commits and “why” context in the body while discouraging vague or overly broad messages.

Use case example: You implement a new UI search feature and want your history to clearly reflect what changed and link it to a ticket for review and changelog generation.

Quick Start

Use the commits skill when drafting a commit message for your latest change and ask it to format it in Conventional Commits style.

Frequently Asked Questions about commits

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

FAQPage Schema
How do I write a conventional commit message for a feature or bug fix?

To write a conventional commit message, you structure it as <type>(<scope>): <subject>, optionally adding a body and footer. This format applies to feature development, bug fixes, refactoring, tests, and maintenance work.

What is the conventional commits format for linking issues in git history?

The conventional commits format uses a structured pattern with an optional footer for issue references. This links your git changes to tickets, making project history easier to understand and automating release notes generation.

How do I choose the right commit type like feat or refactor for my changes?

Choosing the right commit type involves matching your work to categories like feat for features, fix for bug fixes, and refactor for refactoring. The skill provides type guidance and examples to help you select the appropriate one.

Can I generate release notes automatically using conventional commits?

Yes, conventional commits enable reliable tooling for your project history. By enforcing a structured pattern of type, scope, and subject, the format makes project history easier to understand and automate release notes generation.

What should I include in the body of a conventional commit message?

A conventional commit body should provide meaningful "why" context for your change. Best-practice guardrails encourage adding this explanation while keeping commits atomic and discouraging vague or overly broad messages.

Does this conventional commits skill work for documentation updates and tests?

Yes, the conventional commits skill applies to creating commit messages during documentation updates, tests, and maintenance work. It helps you choose an appropriate type and write a concise subject following the formatting rules.