examples

Generate conventional commits with type, scope, summary, body, and footers.

68|6|Updated Apr 16, 2020
One-click install
npx skills add https://github.com/zenobi-us/dotfiles --skill examples
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: examples
Source: https://github.com/zenobi-us/dotfiles/tree/main/ai/files/skills/superpowers/writing-git-commits/examples
Command: npx skills add https://github.com/zenobi-us/dotfiles --skill examples

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides ready-to-use Conventional Commits examples to standardize messages, improve history readability, and streamline automation and release processes.

Core Features & Use Cases

  • Feature, bug, documentation, and breaking-change commit examples with and without scope
  • Body-enabled commits for context, rationale, and references
  • Practical use cases showing how commit messages map to release notes and changelogs

Quick Start

Quick Start: Use a sample commit like "feat(parser): add edge-case handling" as a template; integrate into your repository to standardize messages.

Frequently Asked Questions about examples

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

FAQPage Schema
How do I write commit messages that follow the Conventional Commits standard?

Conventional Commits use a structured format: type(scope): summary. Common types include feat, fix, docs, style, refactor, perf, and test. Add a body for context and footers for references or breaking changes. This standardizes your Git history and enables automated changelog generation.

What's the difference between a feature commit and a breaking-change commit?

Feature commits use type feat and introduce new functionality. Breaking-change commits add a BREAKING CHANGE footer to signal incompatible API or workflow changes. Both follow the same message structure but breaking changes trigger major version bumps in release automation.

Can I use scopes in commit messages for large projects?

Yes. Scopes are optional qualifiers in parentheses after the type—for example, feat(parser) or fix(auth)—that identify the affected component or module. They improve history readability and help teams navigate changes across complex codebases.

How do commit messages map to release notes and changelogs?

Conventional Commits enable automation tools to parse type and scope, then generate release notes grouped by feature, fix, and breaking changes. A well-formed commit history becomes your changelog source, eliminating manual documentation work.

Do I need to include a body and footer in every commit?

No. Type and summary are required; body and footers are optional. Use body to explain why a change was made, and footers for issue references or breaking-change notes. Simple commits need only the one-line format.

What commit types should I use for documentation or styling changes?

Use docs for documentation updates and style for code style changes that don't affect logic or performance. Both follow the same conventional format—type(scope): summary—and are excluded from changelog generation for features and fixes.