跳到主要内容

版本控制策略

概述

ts-graphviz 遵循 语义化版本控制 2.0 以确保一致性和可预测性。此策略阐明了我们如何管理重大变更,特别是与运行时支持相关的变更,以及用户在使用 ts-graphviz 时可以期待什么。

语义化版本控制

版本号格式为 主版本号.次版本号.补丁号,变更分类如下:

  • 主版本号(MAJOR):引入向后不兼容的变更。
  • 次版本号(MINOR):以向后兼容的方式添加功能。
  • 补丁号(PATCH):以向后兼容的方式修复错误。

异常情况:TypeScript 版本更新

在某些情况下,ts-graphviz 可能会偏离严格的语义化版本控制:

  • TypeScript 定义:由于以下原因,TypeScript 类型定义的重大变更可能会出现在次版本之间:
    • TypeScript 在其自身的次要更新中引入重大变更。
    • 采用仅在较新 TypeScript 版本中可用的功能,这可能会提高最低所需的 TypeScript 版本。
提示

对于 TypeScript 项目,我们建议固定 ts-graphviz 的次版本,以控制升级时间和兼容性测试。


信息共享

我们致力于就我们的版本控制和支持策略进行透明的沟通:

  • 文档和发布说明:所有关于版本控制策略和支持级别的变更将记录在我们的官方文档中,并在发布说明中详细说明。
  • 社区参与:鼓励用户订阅更新或关注我们的仓库,以了解最新的发展动态。

迁移支持

为了帮助用户在版本之间过渡,尤其是在发生重大变更时:

  • 迁移指南:我们提供全面的迁移指南,概述升级到新主版本的步骤。
  • 代码示例:包含示例以演示如何调整代码以适应变更。
  • 支持渠道:如果用户在迁移过程中遇到困难,可以通过社区论坛、问题跟踪器或其他支持渠道寻求帮助。