commit-conventions

Standardize git commit messages with Conventional Commits formatting and changelog conventions.

Updated Sep 27, 2024
One-click install
npx skills add https://github.com/sheer-rey/PowerBash --skill commit-conventions-sheer-rey
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-conventions
Source: https://github.com/sheer-rey/PowerBash/tree/main/.claude/skills/commit-conventions
Command: npx skills add https://github.com/sheer-rey/PowerBash --skill commit-conventions-sheer-rey

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes ambiguity from commit history by turning ad hoc git messages into consistent, tool-friendly conventions that teams can review, lint, and release from with confidence.

Core Features & Use Cases

  • Conventional Commits Guidance: Defines valid types, scopes, subjects, and breaking-change markers for clean history.
  • Release and Changelog Support: Shows how to configure conventional-changelog and versioning workflows for automated release notes.
  • Team Workflow Enforcement: Covers commitlint, husky, lint-staged, and commitizen patterns for consistent collaboration.
  • Use Case: A team wants every merge request to produce readable, standardized commits and an auto-generated changelog for releases.

Quick Start

Use this Skill to review a repository’s commit workflow and generate a commit convention standard that matches its team rules.

Frequently Asked Questions about commit-conventions

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

FAQPage Schema
How do I standardize git commit messages for a collaborative software team?

Standardize git commit messages by applying strict type-scope-subject formatting and breaking-change footers. This ensures your collaborative software team can review, lint, and release from a consistent, tool-friendly commit history.

How does conventional commits formatting work with commitlint and husky?

Conventional commits formatting works with commitlint and husky by enforcing strict type-scope-subject rules via git hooks. This combination validates commit messages locally, ensuring they adhere to your repository-level commit policy before they are pushed.

How do I generate automated release notes and changelogs from conventional commits?

Generate automated release notes and changelogs by configuring conventional-changelog workflows. This leverages your standardized conventional commits, including breaking-change markers and issue references, to automatically produce readable versioning release notes.

Can I use commitizen and lint-staged patterns for team workflow enforcement?

Yes, you can use commitizen and lint-staged patterns for team workflow enforcement. These tools integrate with husky and commitlint to prompt developers for correctly formatted conventional commits and validate modified files before commit.

What is the best way to handle revert commits and issue references in conventional commits?

Handle revert commits and issue references by applying specialized conventional commit formatting rules. This ensures reverts are properly tracked with specific types and issue references are included in footers, maintaining a clean, traceable git history for release notes.

Does this commit convention standard support breaking-change footers?

Yes, this commit convention standard fully supports breaking-change footers. It requires strict type-scope-subject formatting that explicitly marks breaking changes, ensuring automated changelog generation correctly flags major version updates.