migration-guide

Solid

Turn a breaking change (an API rename, removed flag, changed default, or moved module) into concrete upgrade steps with before/after examples. Use when the user asks how to migrate, upgrade, or adapt to a breaking change.

Code & Development 7,829 stars 1150 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 89/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
83
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# migration-guide — write upgrade steps for a breaking change Produce a guide that lets a user on the old version land on the new one with the least friction. ## Pin down what actually broke Identify the precise breaking change before writing a word. Get it from the diff and history, not from the description alone: - `git diff <old>..<new>` on the affected surface, and `gh pr view <n>` for the PR that introduced it. - Dispatch the researcher (`purpose: explore`) to confirm the exact old and new shapes: the old name/signature/default, the new one, and whether a compatibility shim or deprecation window exists. Never document a rename or signature change from memory — the exact symbols are what users will copy. ## Structure # Migrating to <version> ## What changed <one paragraph: the change and why, in user terms> ## Upgrade steps 1. <ordered, mechanical steps> ## Before / after ``` # before ... # after ... ``` ## If you can't upgrade yet <deprecation window, shim, or flag to opt out — if one exists> ## Write the steps - Make each step mechanical and verifiable ("rename `--foo` to `--bar`", not "update your flags"). A user should be able to follow it without rereading the whole guide. - Show a minimal, real before/after for each distinct change. Keep examples copy-pasteable. - State explicitly when there is no automated path and a manual edit is required. ## Verify Route the finished guide throug...

Details

Author
omnigent-ai
Repository
omnigent-ai/omnigent
Created
1 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category