القائمة
Use when README.md may be stale. Discovers commits since the last README update, identifies what user-facing surfaces changed, and brings README.md back into sync.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Use when you want to bring every drift-prone artifact in the repo back into sync. Dispatches to all individual update-* skills in the correct order, aggregates their results, and leaves a single combined PR ready to review.
Use when spotifai may have drifted from OSS_SPEC.md. Fetches the latest spec from GitHub, walks its mandates, and fixes each violation so the repository keeps conforming. Runs standalone — it does not shell out to any external validator binary.
Use when files under docs/ may be stale. Discovers commits since the last docs update, maps changed source files to affected conceptual documentation, and brings docs/*.md back into sync.
Use when files under man/ may be stale. Discovers commits since the last manpage update, maps changed CLI definitions to affected pages, and updates man/<cmd>.md to match the current implementation.
Use when LLM prompts under prompts/ may be stale. Discovers changes since the last run and rewrites the affected prompt templates so they stay aligned with their sources of truth.
Use when the marketing website may be stale. Discovers commits since the last website update and refreshes source-derived content under website/ so generated pages match the current README, docs, and spec.
| name | update-readme |
| description | Use when README.md may be stale. Discovers commits since the last README update, identifies what user-facing surfaces changed, and brings README.md back into sync. |
Governing spec sections: §3 (README.md — required sections and content), §21.5 (this skill is mandated because README.md is a drift-prone artifact).
README.md is the primary user-facing documentation for spotifai. Per §3 of OSS_SPEC.md it must cover the project description, installation, a quick-start, usage, contribution pointer, license, and a link to OSS_SPEC.md. It goes stale whenever a CLI flag, subcommand, default, or supported surface changes without a matching edit.
.agent/skills/update-readme/.last-updated contains the git commit hash from the last successful run. Empty means "never run" — fall back to the initial commit of the repository.
Read the baseline:
BASELINE=$(cat .agent/skills/update-readme/.last-updated)
List commits since the baseline:
git log --oneline "$BASELINE"..HEAD
List changed files:
git diff --name-only "$BASELINE"..HEAD
Categorize the changes using the mapping table below.
Read the current README.md so you can preserve voice and unrelated sections while editing.
| Changed files / scope | README section(s) to update |
|---|---|
| Public API surface | Usage / Quick start |
| CLI flags or subcommands | Usage table |
| Default configuration | Quick start |
| Installation instructions / package name | Install |
| New supported platform or language | Supported platforms list |
| License change | License section, badges |
Extend this table every time you find a new source-of-truth file that feeds the README.
Read baseline from .last-updated and run git log / git diff --name-only
Read the current README.md
Walk the mapping table and update each affected section
Verify every shell example is still syntactically valid
Run make test and the project's own conformance check
Write the new baseline:
git rev-parse HEAD > .agent/skills/update-readme/.last-updated
.last-updated was rewritten with the new HEAD.After a run, improve this file in place: