skills.rest
berlysia
berlysiaCOMMUNITY
Explore all skills by this author →
Website𝕏@berlysiaGitHub

commit-conventions

Analyze complex code changes and structure them into atomic conventional commits with clear scope and messages.

9|Updated Aug 20, 2018
Search Tags:#versioning#commit#refactor#conventional-commits#scopes#change-splitting
One-click install
npx skills add https://github.com/berlysia/dotfiles --skill commit-conventions-berlysia
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit-conventions
Source: https://github.com/berlysia/dotfiles/tree/main/.skills/commit-conventions
Command: npx skills add https://github.com/berlysia/dotfiles --skill commit-conventions-berlysia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Complex commit workflows often involve multiple change types, making it hard to split work cleanly and communicate intent.

Core Features & Use Cases

  • Guidance on when to split changes into atomic commits across multiple files and changes
  • Strategies for determining scope and writing precise commit bodies for non-trivial changes
  • Support for complex scenarios such as multiple concurrent changes, refactors with features, and breaking changes, with migration notes when needed.

Quick Start

Describe your complex changes and let this guide split them into atomic commits with clear scopes and messages.

Frequently Asked Questions about commit-conventions

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

FAQPage Schema
How do I split complex code changes into atomic commits?▼

To split complex code changes into atomic commits, analyze the changes to group them by logical scope and type. This involves identifying distinct features or refactors to create a recommended commit sequence with clear messages.

What are conventional commits and when do I need them for refactoring?▼

Conventional commits are a standardized message format used to communicate intent clearly in versioning. You need them during refactoring to separate structural changes from features, ensuring precise commit bodies and scopes for non-trivial updates.

How do I write conventional commit messages for multiple concurrent changes?▼

Writing conventional commit messages for multiple concurrent changes requires determining a clear scope for each change. You should split the work cleanly, enforce conventional-commit style, and provide a recommended sequence to communicate intent accurately.

How do I handle breaking changes and migration notes in commit messages?▼

To handle breaking changes in commit messages, use conventional-commit style to explicitly flag the breaking change. Include migration notes within the commit body to guide users on required transitions and communicate the impact clearly.

What is the best way to structure commits for a project refactor with features?▼

The best way to structure commits for a project refactor with features is to split them into atomic commits. Apply change-splitting strategies to separate pure refactoring from feature additions, using precise scopes and conventional-commit messages to distinguish intent.

Related Skills

Explore More Software Engineering Skills→
t-miura-024t-miura-024

mt-check-git-diff

Analyze git repository changes and retrieve detailed diffs for modified files.

Community
Intermediate
FaysilAlshareefFaysilAlshareef
4

changelog-gen

Generate changelogs from git commits using Conventional Commits and Keep a Changelog formats.

Community
Intermediate
cloudvoyantcloudvoyant

commit

Create conventional Git commits with pre-commit hooks and CI monitoring.

Official
Advanced
ryoppippiryoppippi
256

git-commit-crafter

Create atomic, revertable git commits with Conventional Commits messages.

Community
Basic