update-docs-and-commit

Analyze code diffs and update CHANGELOG.md and README.md documentation.

2|Updated Dec 8, 2018

Search Tags:#git #changelog #documentation #commit #code-changes #docs-update

Ready to run

npx skills add https://github.com/indykish/dotfiles --skill update-docs-and-commit

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs-and-commit
Source: https://github.com/indykish/dotfiles/tree/main/skills/update-docs-and-commit
Command: npx skills add https://github.com/indykish/dotfiles --skill update-docs-and-commit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically aligns user-facing documentation with code changes to reduce drift between code and docs.

Core Features & Use Cases

Analyze diffs to identify user-visible changes and update relevant docs (CHANGELOG.md, README.md) accordingly.
Prepare a focused commit that includes only updated documentation files with a concise message.
Guide teams to maintain documentation quality while avoiding unnecessary changes.

Quick Start

Review code changes, update user-facing docs accordingly, and prepare a clean, focused commit.

Frequently Asked Questions about update-docs-and-commit

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

FAQPage Schema

How do I automatically update documentation based on code changes?▼

To keep documentation aligned with code changes, this Skill analyzes your diffs to identify user-visible updates and applies them directly to your CHANGELOG.md and README.md files. It then prepares a focused, well-annotated commit containing only the modified documentation.

What is the best way to keep a CHANGELOG updated with git commits?▼

The best way to keep a CHANGELOG updated with git commits is to analyze your code diffs for features, fixes, and deprecations, then generate a focused commit that captures these changes in your CHANGELOG.md. This reduces drift between code and docs.

How do I prepare a clean git commit that only includes updated docs?▼

To prepare a clean git commit that only includes updated docs, this Skill separates documentation updates from code changes and generates a focused commit message. It ensures your commits are well-annotated and contain only files like README.md and CHANGELOG.md.

Can I use this to update README.md based on feature deprecations?▼

Yes, you can use this to update README.md based on feature deprecations. The Skill specifically identifies user-visible changes such as deprecations from your code diffs and updates the relevant sections of your user-facing documentation accordingly.

When should I avoid combining documentation updates with code changes?▼

You should avoid combining documentation updates with code changes when you need focused, well-annotated git history. This Skill isolates updated docs into a separate commit to maintain documentation quality and prevent unnecessary mixed changes.