vscode-go项目CHANGELOG管理规范演进

在软件开发过程中，变更日志（CHANGELOG）是记录项目版本变更历史的重要文档。vscode-go项目团队近期对其CHANGELOG管理方式进行了重大改进，旨在优化开发流程并提升用户体验。

原有管理方式的痛点

vscode-go项目原先的CHANGELOG管理存在几个明显问题：

1. 发布流程复杂：变更日志需要在稳定版本发布时手动编写，增加了发布过程的复杂性和人工操作负担。

2. 信息滞后：预发布版本构建时往往还未编写变更日志，导致用户无法及时了解新特性或重要变更。

3. 维护困难：已发布的变更日志如需修正，必须发布新版本才能更新，造成不必要的版本迭代。

4. 责任集中：变更日志编写工作集中在少数发布负责人身上，而非由实际贡献者完成。

新的管理方案

为解决上述问题，团队决定采用"Keep a changelog"规范，并对管理流程进行以下改进：

1. 引入"Unreleased"章节：在CHANGELOG中专门设置"未发布"区域，实时记录开发中的重大变更。

2. 根目录存放：将CHANGELOG.md文件移至项目根目录，提高可见性和可访问性。

3. 动态引用机制：扩展包中不再嵌入完整变更日志，而是提供指向主分支最新版本的链接。

4. 贡献者责任制：鼓励功能开发者亲自记录其变更内容，确保描述准确性和完整性。

5. 自动化处理：通过relui发布工具自动将"Unreleased"内容迁移至发布版本章节，并同步到GitHub Release页面。

版本管理策略调整

配合新的变更日志管理方式，项目团队也调整了版本号管理策略：

1. 主版本号：保留用于重大架构调整或不兼容变更。

2. 次版本号：用于新功能引入或配置变更。

3. 修订号：仅用于问题修复和小幅调整。对于修订版发布，变更日志将简化为指向里程碑的链接。

格式优化

在实施过程中，团队还发现并解决了变更日志标题格式的问题：

• 原先版本标题包含发布日期（如"v0.42.0 - 17 Jul, 2024"），导致锚链接复杂化。

• 新格式将日期信息移至标题下方单独行，保持标题简洁并确保锚链接稳定性。

预期收益

这套改进方案将为项目带来多方面好处：

1. 降低发布门槛：自动化处理和分散责任使发布流程更加高效。

2. 提升信息时效性：开发中的变更能够及时记录并呈现给预发布版本用户。

3. 增强可维护性：错误修正不再依赖版本发布，可直接在主分支更新。

4. 改善用户体验：更清晰、及时的变更信息帮助用户更好地了解版本演进。

这种变更日志管理方式的演进，体现了vscode-go项目对开发流程优化和用户体验提升的持续追求，也为其他开源项目提供了有价值的参考范例。