migration-guidance

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

Install
npx skills add 'https://github.com/Effect-TS/effect/tree/main/.agents/skills/migration-guidance'
Download bundle ↓
main · 90695b0Scanned 2026-09-15

Contributors

GitHub-linked commit authors for this SKILL.md at the saved revision. Co-authors and history before file renames are not included.

File history ↗

annotations.md

annotations.mdBrowse 3 files
View on GitHub
← Back to SKILL.md

Migration Annotations

Add or update one YAML file per v3 module under migration/annotations/. Use stable API IDs without trailing #type or #value facets:

effect/Effect#async:
  replacement: Effect.callback
  note: Use the callback constructor.
  example: Effect.callback((resume) => resume(Effect.void))

Every annotation requires replacement and note; example is optional. Use replacement: none when there is no direct replacement and explain the supported migration strategy instead of inventing an equivalent API.

Referenced from SKILL.md