migration-guidance
Use when changing how a v3 public API maps to v4, editing migration annotations, or regenerating migration/v3-to-v4.md.
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-14
- Stars
- ★ 6
- Forks
- 1
01 前言 Front Matter
- name
- migration-guidance
- description
- Use when changing how a v3 public API maps to v4, editing migration annotations, or regenerating migration/v3-to-v4.md.
02 资源文件 2
- 参考文档annotations.md547 B
- 参考文档generation.md574 B
03 SKILL.md 正文
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.
- Account for every affected v3 symbol.
- Read annotations.md before adding or changing annotation YAML. Verify every suggested replacement against implementation and tests.
- 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.
- 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.
04 同仓库更多 Skills
vendored-assets
Vendored assets. Use when importing or updating checked-in third-party or externally generated JavaScript, CSS, registries, schemas, snapshots, or Scalar, Swagger, and MIME artifacts.
test-development
Test development. Use when adding or changing Vitest or Tstyche coverage. Choose Tstyche only for intended compiler behavior such as inference, assignability, rejection, or displayed public types.
pull-requests
Pull request finalization. Use when a change works and is about to be opened as a pull request, or when updating or continuing an existing one.
performance-analysis
Performance analysis. Use for runtime throughput or latency benchmarks, TypeScript compiler cost, performance regressions, comparison harnesses, or thresholds.
package-development
Package registration. Use when adding a workspace package, making a private package publishable, renaming a package, or moving its workspace path.
jsdocs
Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.