软件工程： 版本管理

版本号管理

版本格式：主版本号.次版本号.修订号，版本号递增规则如下：
主版本号：当你做了不兼容的 API 修改，
次版本号：当你做了向下兼容的功能性新增，
修订号：当你做了向下兼容的问题修正。

考虑使用这样的版本号格式：X.Y.Z（主版本号.次版本号.修订号）修复问题但不影响 API 时，递增修订号；API 保持向下兼容的新增及修改时，递增次版本号；进行不向下兼容的修改时，递增主版本号。

• 修订号 Z（x.y.Z | x > 0）必须（MUST）在只做了向下兼容的修正时才递增。这里的修正指的是针对不正确结果而进行的内部修改。
• 次版本号 Y（x.Y.z | x > 0）必须（MUST）在有向下兼容的新功能出现时递增。在任何公共 API 的功能被标记为弃用时也必须（MUST）递增。也可以（MAY）在内部程序有大量新功能或改进被加入时递增，其中可以（MAY）包括修订级别的改变。每当次版本号递增时，修订号必须（MUST）归零。
• 主版本号 X（X.y.z | X > 0）必须（MUST）在有任何不兼容的修改被加入公共 API 时递增。其中可以（MAY）包括次版本号及修订级别的改变。每当主版本号递增时，次版本号和修订号必须（MUST）归零。

个人修改建议：
修改了几个bug，一般是改修订号。新增或修改功能一般是次版本号。主版本号基本不改，除非软件重构

可以参考下面文档来管理版本号

语义化版本2.0.0

ChangeLog使用说明

除了已经发布的版本号管理外，日常开发中也应该对代码的修改内容做记录。用到的文件就是ChangeLog.md。下面是针对该文件使用的一些说明。

指导原则

记住日志是写给人而非机器的。
每个版本都应该有独立的入口。
同类改动应该分组放置。
不同版本应分别设置链接。
新版本在前，旧版本在后。
应包括每个版本的发布日期。
注明是否遵守语义化版本规范。

变动类型

Added: 新添加的功能。
Changed: 对现有功能的变更。
Deprecated: 已经不建议使用，即将移除的功能。
Removed: 已经移除的功能。
Fixed: 对 bug 的修复。
Security: 对安全性的改进。

注意

TAPD或者gitlab Issue上面的问题描述后需添加ID号，添加方式：
TAPD：问题描述（ID1003856）
gitlab Issue: 问题描述（#32234）

参考文档：

keepachangelog