指引如何为 puerts 项目编写 Unity 和 Unreal 的 changelog
| 平台 | 英文版 | 中文版 |
|---|---|---|
| Unity | unity/changelog.md | unity/changelog-hans.md |
| Unreal | unreal/changelog.md | unreal/changelog-hans.md |
用户会告诉你要更新哪个平台(Unity 或 Unreal)的 changelog。
3.0.1,Unreal 的 1.0.9)。3.0.1 → 3.0.2,1.0.9 → 1.0.10),但如果用户指定了版本号则以用户为准。根据平台确定 tag 命名规则:
Unity_v{版本号},例如 Unity_v3.0.1Unreal_v{版本号},例如 Unreal_v1.0.9执行 git log 获取 commit 列表,只关注对应平台目录的改动:
Unity 示例(假设上一版本是 3.0.1,新版本是 3.0.2):
# 如果新版本 tag 已存在
git log Unity_v3.0.1..Unity_v3.0.2 --oneline -- unity/
# 如果新版本 tag 尚未打,则对比到 master
git log Unity_v3.0.1..master --oneline -- unity/
Unreal 示例(假设上一版本是 1.0.9,新版本是 1.0.10):
# 如果新版本 tag 已存在
git log Unreal_v1.0.9..Unreal_v1.0.10 --oneline -- unreal/
# 如果新版本 tag 尚未打,则对比到 master
git log Unreal_v1.0.9..master --oneline -- unreal/
git show <commit_hash> 或 git diff 查看具体修改内容来确定。必须同时编写中文版和英文版,写到对应的文件中。新版本的内容插入到文件最前面(在文件头部注释之后、旧版本之前)。
英文版(unity/changelog.md):
## [3.0.2] - 2025-04-01
1. Fixed xxx issue fix #1234
2. Added support for xxx feature (#5678)
3. Optimized xxx performance
中文版(unity/changelog-hans.md):
## [3.0.2] - 2025-04-01
1. 修复了 xxx 问题 fix #1234
2. 新增 xxx 功能支持 (#5678)
3. 优化了 xxx 性能
格式要点:
## [版本号] - 日期(日期格式 YYYY-MM-DD 或 YYYY-M-D)1. 2. 3. ...[跳转中文](./changelog-hans.md) 链接[english version](./changelog.md) 链接fix #issue号 或 (#PR号)英文版(unreal/changelog.md):
### v1.0.10 2025/4/1
#### New Features
* Added support for xxx
#### Optimizations
* Optimized xxx performance (#1234)
#### Changes
* Changed xxx behavior
#### Bug Fixes
* Fixed xxx crash issue (fix #5678)
中文版(unreal/changelog-hans.md):
### v1.0.10 2025年4月1日
#### 新增特性
* 新增 xxx 支持
#### 优化
* 优化了 xxx 性能 (#1234)
#### 变更
* 变更了 xxx 行为
#### bug修复
* 修复了 xxx 崩溃问题 (fix #5678)
格式要点:
### v版本号 YYYY/M/D,中文版 ### v版本号 YYYY年M月D日New Features / Optimizations / Changes / Bug Fixes(中文:新增特性 / 优化 / 变更 / bug修复)####* 无序列表fix #issue号 或 (#PR号)将新版本的 changelog 内容插入到对应文件中,位置在文件头部元信息之后、上一个版本之前。确保中英文两个文件都更新。34:["$","$L3b",null,{"content":"$3c","frontMatter":{"name":"puerts_changelogs","description":"指引如何为 puerts 项目编写 Unity 和 Unreal 的 changelog"}}]