SkillsAdd

smithery.ai

review-readme

檢查 README.md 是否需要根據最近的 commits 更新。Use when the user wants to review whether README.md is up-to-date with recent code changes.

First seen Mar 21, 2026

Installation

$ npx skills add https://smithery.ai
View on skills.sh ↗ Website ↗

Summary

  • 檢查 README.md 是否需要根據最近的 commits 更新。Use when the user wants to review whether README.md is up-to-date with recent code changes.
  • Triggers on requests like "review readme", "check readme", "檢查 README", "更新 README", or when the user invokes /review-readme.
  • Analyzes all commits since the last README.md modification and suggests specific updates if needed.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

flutter-add-widget-preview Similar name
flutter/agent-plugins

Adds interactive widget previews to the project using the previews.dart system. Use when creati…

29.4K installs
recipe-review-overdue-tasks Similar name
googleworkspace/cli

Find Google Tasks that are past due and need attention.

27.2K installs
recipe-review-meet-participants Similar name
googleworkspace/cli

Review who attended a Google Meet conference and for how long.

26.9K installs
security-review Similar name
getsentry/skills

Security code review for vulnerabilities.

15.5K installs
web-design-reviewer Similar name
github/awesome-copilot

This skill enables visual inspection of websites running locally or remotely to identify and fi…

13.3K installs
sql-code-review Similar name
github/awesome-copilot

Universal SQL code review assistant that performs comprehensive security, maintainability, and …

13K installs

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai
smithery-ai-cli 7.8K frontend-design 6.2K skill-creator 2.5K ck:ui-ux-pro-max 1.3K pdf 1.2K xlsx 966 pptx 894 docx 884 webapp-testing 1 web-design-reviewer 657

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,827 B
  • docs SUMMARY.md 408 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

Review README

Analyze commits since the last README.md modification and determine whether README.md needs updating.

Workflow

  1. Find the last README.md commit

``bash git log -1 --format="%H %s" -- README.md ``

  1. List all commits since that point

``bash git log <last-readme-commit>..HEAD --oneline --no-merges `` If no commits exist, report "README.md is up-to-date" and stop.

  1. Analyze each commit for README-relevance

Review diffs (git show <hash> --stat and git show <hash> as needed). Flag changes that affect README.md: - New or removed features / generation modes - New or changed commands (npm run ...) - New dependencies or prerequisites - Architecture changes (new composables, stores, workers, routes) - Changed API / configuration patterns - New environment variables or setup steps

  1. Report findings in zh-TW

Present a structured summary: - 相關 commits: Commits that may require README updates, with brief reason - 建議修改: For each, describe the specific README section(s) to update and the proposed change - 無需修改: Commits confirmed irrelevant (bug fixes, style tweaks, test-only, etc.)

  1. Confirm and apply

Ask the user to confirm the proposed changes before editing README.md. After confirmation, apply edits and show a summary of what was changed.