pre-commit-docs-sync
CommunityEnforce up-to-date docs before every commit.
Authorbakwankawa
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill prevents commits with outdated or misleading documentation by ensuring README.md and .cursor/project_architecture.md accurately reflect staged changes.
Core Features & Use Cases
- Documentation parity checks: validates that staged changes are reflected in README.md and .cursor/project_architecture.md.
- Pre-commit gate: stops commits until documentation parity is achieved.
- Guidance & diffs: highlights differences and suggests doc updates to align with code changes.
Quick Start
Stage your changes and trigger the pre-commit docs sync as part of your pre-commit workflow. If docs are out of date, revise README.md or project_architecture.md, re-stage, and re-run until parity is achieved.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: pre-commit-docs-sync Download link: https://github.com/bakwankawa/lazy-code-skill/archive/main.zip#pre-commit-docs-sync Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.