commit-readiness-checker

Validate version bumps, changelog entries, and synced files before commit.

Updated Dec 4, 2025

Search Tags:#git #versioning #commit #pre-commit #CHANGELOG #readiness

Ready to run

npx skills add https://github.com/christianearle01/claude-config-template --skill commit-readiness-checker

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-readiness-checker
Source: https://github.com/christianearle01/claude-config-template/tree/main/.claude/skills/commit-readiness-checker
Command: npx skills add https://github.com/christianearle01/claude-config-template --skill commit-readiness-checker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill validates release readiness before committing by ensuring version bumps, changelog entries, and documentation synchronization are all in place to prevent incomplete releases and post-commit fixes.

Core Features & Use Cases

Full readiness checks: Verifies version bump in version.json and CLAUDE.md, CHANGELOG entry, and files synchronization, plus a clean git status before commit.
Automatic commit message draft: Generates a ready-to-use commit message aligned with the release notes and versioning.
Guided troubleshooting: Provides actionable blockers and next steps if anything is missing.

Quick Start

Run the readiness check to determine if you can commit now, then follow the suggested steps to address blockers and draft the message.

Frequently Asked Questions about commit-readiness-checker

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

FAQPage Schema

How do I validate release readiness before a git commit?▼

Pre-commit readiness validation checks your version bump, changelog entry, and file synchronization before committing. This ensures documentation like README and CLAUDE.md matches the new version, preventing incomplete releases.

How do I check if my version bump and CHANGELOG are synced before committing?▼

Checking version bump and CHANGELOG synchronization involves verifying version.json and CLAUDE.md against your release notes. This process ensures files are synced before commit, providing deterministic blockers and actionable guidance to fix any missing entries.

Can I auto-generate a git commit message from release notes and version bumps?▼

You can auto-generate a git commit message from release notes and versioning changes. After verifying a clean git status and successful readiness checks, an automatic commit message draft is created and aligned with your release notes.

What is pre-commit release readiness verification in software engineering?▼

Pre-commit release readiness verification is a validation process ensuring version bumps, changelog entries, and documentation are synchronized before a commit. It applies to software release workflows requiring deterministic blockers to prevent incomplete releases and post-commit fixes.

Does the readiness checker work without external dependencies?▼

Yes, the readiness checker works without external dependencies. It performs full readiness checks by reading multiple internal sources like version.json, CLAUDE.md, README, and SETUP_CONTEXT directly, requiring no additional components or external packages to function.

Why is my pre-commit readiness check failing on git status?▼

Your pre-commit readiness check fails on git status when the working directory is not clean. The validation requires a clean git status before committing, providing actionable blockers and next steps to guide you in resolving any uncommitted changes or missing version updates.