Migration Guidance

Use when changing how a v3 public API maps to v4, editing migration annotations, or regenerating migration/v3-to-v4.md.

foldkit 752cba3 3 files · 2.2 KB Updated

File contents

Update guidance when a v3 public module or API is renamed, moved, removed, replaced, or gains a materially different v4 contract. A v4-only API without a v3 counterpart does not automatically need an annotation.

  1. Account for every affected v3 symbol.
  2. Read annotations.md before adding or changing annotation YAML. Verify every suggested replacement against implementation and tests.
  3. When checking or regenerating the reference, or when the API change exists in a committed ref, read generation.md. Otherwise report that generation is deferred.
  4. When output was generated, inspect it for unrelated movement and stale refs.

The task is complete when every affected v3 symbol is accounted for, annotation replacements are verified, checks and generation succeed when the change is in a committed ref, and every generated difference is explained. Report deferred checks explicitly for uncommitted API changes.

foldkit/foldkit/tree/main/repos/effect/.agents/skills/migration-guidance commit 752cba35e5

Frequently asked questions

npx skillmds@latest add foldkit/migration-guidance