在 Pull Request 中编写更新日志
本页面由 PageTurner AI 翻译(测试版)。未经项目官方认可。 发现错误? 报告问题 →
您在 pull request 中的更新日志条目相当于变更的"简要总结":是否影响 Android?是否包含破坏性变更?是否新增了功能?
使用标准化格式提供更新日志有助于发布协调员编写发布说明。请在 pull request 描述中包含更新日志。如果该 pull request 被合并,其描述内容将作为提交信息使用。
格式规范
更新日志条目采用以下格式:
## Changelog:
[Category] [Type] - Message
"类别(Category)"字段可选值:
-
Android:适用于影响 Android 平台的变更
-
iOS:适用于影响 iOS 平台的变更
-
General:适用于不属于其他类别的变更
-
Internal:适用于与使用发布说明的开发者无关的内部变更
"类型(Type)"字段可选值:
-
Breaking:破坏性变更
-
Added:新增功能
-
Changed:现有功能调整
-
Deprecated:即将移除的功能
-
Removed:已移除的功能
-
Fixed:问题修复
-
Security:安全漏洞修复
最后在"消息(Message)"字段说明变更内容及原因。请简明扼要地向 React Native 用户描述重要变更。
更多细节请参考:如何编写优质更新日志? 和 为何需要维护更新日志?
示例
-
[General] [Added] - Add snapToOffsets prop to ScrollView component -
[General] [Fixed] - Fix various issues in snapToInterval on ScrollView component -
[iOS] [Fixed] - Fix crash in RCTImagePicker(修复了 RCTImagePicker 中的崩溃问题)
常见问题
如果我的 pull request 同时包含 Android 和 JavaScript 变更?
使用 Android 类别。
如果我的 pull request 同时包含 Android 和 iOS 变更?
若变更通过单个 pull request 提交,使用 General 类别。
如果我的 pull request 同时包含 Android、iOS 和 JavaScript 变更?
若变更通过单个 pull request 提交,使用 General 类别。
如果...?
任何更新日志都比没有强。如果不确定类别选择是否正确,可在"消息"字段中简洁描述变更内容。
这些条目将被 @rnx-kit/rn-changelog-generator 脚本用于生成初稿,再由发布协调员进行编辑。
您的说明将用于在最终发布说明的正确位置添加变更记录。