Why should I separate documentation from code commits?

Separating documentation from code allows reviewers to focus on logic changes independently. It also ensures that if a code feature needs to be reverted, the documentation changes don't unnecessarily go with it if they are still relevant.

How do atomic commits help with Git Bisect?

Atomic commits make Git Bisect much more powerful because they pinpoint the exact logical change that introduced a regression, rather than pointing to a massive commit containing dozens of unrelated changes.

What is an atomic commit?

An atomic commit is the smallest set of changes that represents a single, complete unit of work. It should have one clear purpose and be able to be reverted without impacting unrelated parts of the codebase.

When is it appropriate to combine changes into one commit?

You should combine changes that are intrinsically linked, such as a new feature and its unit tests, or a bug fix and its regression test, as they change for the same logical reason.

What is the 'Smell Test' for commits?

The 'Smell Test' suggests that if you cannot describe your commit in one sentence without using the word 'and', the commit is likely too large and should be split into multiple atomic commits.

Atomic Commits

Name: Atomic Commits
Author: WhiteKr

byWhiteKr

0•

Herramientas para Desarrolladores

Enforces the single responsibility principle for version control by organizing code changes into discrete, logical, and reversible units.

Atomic Commits is a specialized skill designed to help developers maintain a clean and professional Git history. It applies the 'single responsibility principle' to version control, ensuring that every commit represents a complete unit of work that can be easily reviewed, debugged, and reverted without side effects. The skill provides clear guidance on when to separate changes—such as keeping bug fixes distinct from refactoring—and when to group them, like pairing implementation code with its corresponding tests. By following these patterns, teams can significantly improve code review speed and the effectiveness of debugging tools like git bisect.

Características Principales

01Guides the logical grouping of implementation code with relevant unit tests.

020 GitHub stars

03Provides specific criteria for separating unrelated changes into discrete commits.

04Applies the Single Responsibility Principle to Git version control workflows.

05Implements a 'Smell Test' to identify and split overloaded commits containing 'and'.

06Ensures commits are complete, functional, and independently testable.

Casos de Uso

01Isolating refactoring efforts from new feature development to ensure safe and selective reverting.

02Separating documentation updates from functional code changes to streamline technical reviews.

03Splitting a large development session into clean, individual commits for feature additions and bug fixes.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add whitekr/whitekr-claude-plugins atomic-commits

For use in Claude.ai and ChatGPT

Download Skill