版本与更新策略

我们深知，对于一个被依赖的库来说，稳定性和可预测性至关重要。本页面详细说明了 Esdora 的版本管理规范，以帮助你理解我们的更新策略，并安全地管理你的项目依赖。

语义化版本 (SemVer)

Esdora 的所有发布包（如 @esdora/kit）都严格遵循 语义化版本 2.0.0 规范。

版本号格式为 主版本号.次版本号.修订号 (例: 1.2.3)：

• 主版本号 (MAJOR): 当我们做出不兼容的 API 变更时，会增加主版本号。升级主版本可能需要你修改自己的代码。
• 次版本号 (MINOR): 当我们以向后兼容的方式添加新功能时，会增加次版本号。你可以安全地升级。
• 修订号 (PATCH): 当我们做出向后兼容的 Bug 修复时，会增加修订号。我们强烈建议你始终保持在最新的修订版本。

发布周期与变更日志 (Changelog)

我们没有严格的固定发布周期。通常，当积累了一定数量的新功能或重要的 Bug 修复后，我们就会进行一次新的版本发布。

我们使用 Changesets 来管理版本和生成变更日志。这意味着：

• 变更日志是自动生成的：每次版本发布时，每个包的 CHANGELOG.md 文件都会根据开发过程中提交的 changeset 文件自动更新。
• 日志内容清晰可靠：CHANGELOG.md 中的每一条记录都直接来源于开发者的变更描述，确保了信息的准确性。

你可以在每个包的根目录下找到对应的 CHANGELOG.md 文件，以了解从一个版本到下一个版本的详细变更历史。

弃用策略 (Deprecation Policy)

我们理解 API 的稳定性非常重要。因此，我们不会轻易地移除或破坏性地更改一个函数。

当我们计划弃用某个函数或 API 时，会遵循以下流程：

1. 标记为 @deprecated: 在至少一个次版本中，该函数将在 JSDoc 中被标记为 @deprecated，并在运行时（开发模式下）输出一个弃用警告。文档中也会明确指出其替代方案。
2. 移除: 在下一个主版本发布时，这个被标记为弃用的函数才会被正式移除。

这为你提供了充足的时间来迁移你的代码。

保持更新

我们建议你使用 pnpm up --latest '@esdora/*' 或类似的命令，定期将你的项目依赖更新到最新的次版本和修订版本，以获取最新的功能和 Bug 修复。