git-commit_skill

Overview

This skill reviews project consistency after code changes, updates relevant documentation, records a session summary to ~/history.log when present, and then commits and pushes the work. It helps ensure code, design docs, README, and CHANGELOG stay aligned before opening a PR. Use it after finishing coding tasks to catch documentation drift and produce a clear commit history.

How this skill works

The skill scans changed files, compares implementation against DESIGN.md and other design documents, and checks README.md and CHANGELOG.md for required updates. If ~/history.log exists it appends a short session summary. It generates a concise consistency report, applies any simple fixes you approve, stages changes, creates a human-like commit message, and pushes the branch. Optionally it can create a PR with reviewers.

When to use it

• After completing a feature implementation
• After fixing a bug or regression
• Before creating a pull request
• After a large refactor or API change
• When you want to keep docs and changelog current

Best practices

• Run the full /git-commit after finishing development, use --quick for lightweight checks
• Keep design documents (DESIGN.md) updated as the source of truth for architecture and API behavior
• Write short, human-like commit messages that describe what changed, not tooling or agents
• Append a short, factual session summary to ~/history.log if it exists to preserve context
• Address critical documentation gaps before committing; commit fixes together with related code changes

Example use cases

• Finish implementing an API endpoint and ensure route signatures and README examples match the code
• Fix a bug, then verify CHANGELOG.md documents the fix and update history.log with reproduction notes
• Refactor data models and confirm DESIGN.md and schema docs reflect the new structure
• Prepare a branch for PR: run the check, apply small doc fixes, commit with a clear message, and push
• Run a quick check (--quick) to verify README and CHANGELOG after minor edits