CommunityProductivity & Collaborationgithub.com

mtai0524/claude-skills

Keep README.md and project docs in sync when features, setup, or configuration change. Use after adding a feature, changing setup steps, adding env vars, or when the user asks to update docs.

What is claude-skills?

claude-skills is a Claude Code agent skill that keep README.md and project docs in sync when features, setup, or configuration change. Use after adding a feature, changing setup steps, adding env vars, or when the user asks to update docs.

Works with✓Claude Code~Codex CLI~Cursor
Part ofAgent Workflows
npx skills add https://github.com/mtai0524/claude-skills/tree/HEAD/skills/docs-readme

Installed? Explore more Productivity & Collaboration skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

View original→Browse all skills

Ask in your favorite AI

Open a new chat with this agent skill pre-loaded.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentation

Docs & README

When a change affects how someone installs, runs, configures, or uses the project, update README.md in the same change.

README should cover, briefly:

  • What the project is (1-2 sentences).
  • Requirements and install steps.
  • How to run, test, and build — copy-pasteable commands.
  • Configuration: every env var with purpose and example value (never real secrets).
  • Short usage examples for main features.

Rules:

  • Edit only the sections the change affects; do not rewrite the whole file.
  • Verify every command you document actually works.
  • English, short sentences, no marketing language.

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

mtai0524/claude-skills

Branch naming convention and the rule to branch before changing code on the default branch (main/master). Use when starting new work, creating a branch, or when about to edit code while on the default branch.

mtai0524/claude-skills

Update CHANGELOG.md from commits since the last tag, following Keep a Changelog. Use when the user asks to update the changelog or prepare a release.

mtai0524/claude-skills

Write git commit messages in Conventional Commits format. Use whenever creating a commit, when the user asks for a commit message, and at the end of every task that changed files (to propose the commit message).

mtai0524/claude-skills

Systematic debugging that finds and fixes the root cause instead of patching symptoms. Use for any bug, error, failing test, or unexpected behavior.

Related Skills

steipete/gemini

Gemini CLI one-shot prompts, summaries, generation, skills, hooks, MCP, or Gemma routing.

community

steipete/gh-issues

Fetch GitHub issues, select candidates, spawn background fix agents, open PRs, and optionally process PR review comments.

community

steipete/skill-creator

Create, edit, audit, tidy, validate, or restructure AgentSkills and SKILL.md files.

community

steipete/clawhub

Search, install, update, sync, or publish agent skills with the ClawHub CLI and registry.

community

steipete/coding-agent

Delegate coding work to Codex, Claude Code, or OpenCode as background workers; not simple edits or read-only code lookup.

community

steipete/mcporter

List, configure, authenticate, call, and inspect MCP servers/tools with mcporter over HTTP or stdio.

community
← More Productivity & Collaboration skills