AgentSkillsCN

sd-readme

当您需要更新软件包的 README.md 文件以反映近期代码变更，或被要求将 README 与当前实现同步时使用此技能。

SKILL.md
--- frontmatter
name: sd-readme
description: Use when updating a package README.md to reflect recent code changes, or when asked to sync README with current implementation
argument-hint: "<package-name or path>"

sd-readme

Update a package's README.md based on git commits since its last modification.

Step 1: Resolve Package Path

$ARGUMENTS is the package name or path (e.g., sd-cli, packages/sd-cli, packages/core-common).

  • •If it doesn't start with packages/, prepend packages/.
  • •Verify <pkg-path>/README.md exists. If not, stop and report.

Step 2: Gather Change Context

Run these git commands in sequence (second depends on first):

bash
# 1. Last commit that modified the README
git log -1 --format="%H %ai %s" -- <pkg-path>/README.md

If git log returns no output (README was never committed), treat all package commits as relevant:

bash
git log --oneline -- <pkg-path>/

Otherwise, take the commit hash from above, then:

bash
# 2. All commits to the package since that hash
git log <hash>..HEAD --oneline -- <pkg-path>/

If no commits exist since the last README update → report "README is already up to date" and stop.

Step 3: Categorize Changes

For each commit, assess README impact:

CategoryImpactREADME Action
New public export (function, class, type)HighAdd documentation
Changed API signature (params, return type)HighUpdate existing docs
Removed/renamed public APIHighRemove or update
New feature (user-visible behavior)MediumAdd description/example
Bug fixLowSkip unless it changes documented behavior
Refactoring (internal)NoneSkip
Build/config/dependency changeNoneSkip
Version bumpNoneSkip

For commits with unclear impact, inspect the actual diff:

bash
git show <hash> -- <pkg-path>/src/

Step 4: Cross-Check Exports

Read <pkg-path>/src/index.ts to verify:

  • •All current public exports are documented in the README
  • •No removed exports are still documented
  • •Any new exports not yet in README are identified

This catches changes that might have been missed in commit analysis.

Step 5: Present Findings

Before editing, report to the user:

  1. •Commits analyzed: total count and date range
  2. •Changes requiring README updates: list each with category and what to add/modify
  3. •No-action commits: briefly note what was skipped and why
  4. •Export mismatches: any undocumented or stale exports found

Wait for user confirmation before proceeding to edit.

Step 6: Update README

Read the current README, then edit only the affected sections.

Rules:

  • •README content is written in English
  • •Preserve existing structure — do not reorganize or rewrite unchanged sections
  • •Match style — follow the same documentation depth, table format, and code example style as existing entries
  • •For new APIs: include description, usage example, and parameter/option table if the existing style uses them
  • •Remove documentation for APIs that no longer exist
  • •Do not add version history, changelog, or "recently updated" sections