git-commit

Validate code-documentation alignment and update CHANGELOG.md, README.md, and DESIGN.md before committing.

66|5|Updated Nov 12, 2023
One-click install
npx skills add https://github.com/tsaol/awesome-claude --skill git-commit-tsaol
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit
Source: https://github.com/tsaol/awesome-claude/tree/main/skills/git-commit
Command: npx skills add https://github.com/tsaol/awesome-claude --skill git-commit-tsaol

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures project consistency after code changes by validating alignment between code and documentation, updating CHANGELOG/README/DESIGN.md, and preparing a commit and push.

Core Features & Use Cases

  • Code-Docs Alignment: Verifies implementation matches design specs and documentation.
  • Documentation Updates: Updates CHANGELOG.md, README.md, and DESIGN.md as needed.
  • History & Commit Prep: Updates ~/history.log (if present) and guides a clean commit before pushing.
  • Use Case: After finishing a feature or bug fix, run this skill to ensure all docs reflect the changes and to prepare the final commit.

Quick Start

Run the skill after completing code changes:

  • Check status: git status
  • Review diffs: git diff
  • Update docs and changelog if needed
  • Stage and commit: git add -A && git commit -m "update docs and changelog after feature X"
  • Push to remote: git push

Frequently Asked Questions about git-commit

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

FAQPage Schema
How do I keep code and documentation synchronized before a git commit?

To keep code and documentation synchronized before a git commit, validate implementation against design specs and update CHANGELOG.md, README.md, and DESIGN.md to reflect the changes before staging and pushing.

How do I update CHANGELOG and history log after finishing a feature or bug fix?

Update CHANGELOG and history log by reviewing git diffs after a bug fix, aligning the changes with design specs, updating ~/history.log if present, and preparing a clean git commit and push.

Does automated documentation validation work for refactoring changes?

Automated documentation validation works for refactoring changes by verifying the implementation matches design specs and ensuring README.md and DESIGN.md are updated before the final git push.

What is the best way to enforce a code review and docs update workflow in git?

The best way to enforce a docs update workflow in git is to apply an end-to-end process that reviews git diffs, aligns with design specs, updates history logs, and performs the final git commit and push.

Do I need a history.log file present to automate my git commit workflow?

You do not need a history.log file present to automate your git commit workflow; the process updates ~/history.log only if it already exists before preparing the commit and pushing.