跳到主要内容

Pull Request 中的更新日志

你的 pull request 中的更新日志条目就像是对你的更改的“tl;dr: ”：它们是否影响 Android？这些是破坏性更改吗？是否有新的东西被添加？

使用标准化格式提供更新日志有助于发布协调员编写发布说明。请在你的 pull request 描述中包含更新日志。你的 pull request 描述将用作 pull request 合并后的提交消息。

格式​

更新日志条目具有以下格式

## Changelog:

[Category] [Type] - Message

“类别”字段可以是以下之一

  • Android，用于影响 Android 的更改。
  • iOS，用于影响 iOS 的更改。
  • 通用，用于不属于任何其他类别的更改。
  • 内部，用于与使用发布说明的开发者无关的更改。

“类型”字段可以是以下之一

  • 破坏性，用于破坏性更改。
  • 新增，用于新功能。
  • 已更改，用于现有功能的更改。
  • 已弃用，用于即将删除的功能。
  • 已移除，用于现在已删除的功能。
  • 已修复，用于任何错误修复。
  • 安全，在存在漏洞的情况下。

最后，“消息”字段可以回答功能层面的“什么和为什么”。使用它向 React Native 用户简要介绍值得注意的更改。

有关更多详细信息，请参阅 如何编写好的更新日志？ 和 为什么要保留更新日志？

示例​

  • [通用] [新增] - 向 ScrollView 组件添加 snapToOffsets 属性
  • [通用] [已修复] - 修复 ScrollView 组件上 snapToInterval 中的各种问题
  • [iOS] [已修复] - 修复 RCTImagePicker 中的崩溃

FAQ​

如果我的 pull request 同时包含对 Android 和 JavaScript 的更改怎么办？​

使用 Android 类别。

如果我的 pull request 同时包含对 Android 和 iOS 的更改怎么办？​

如果更改在单个 pull request 中完成，则使用通用类别。

如果我的 pull request 同时包含对 Android、iOS 和 JavaScript 的更改怎么办？​

如果更改在单个 pull request 中完成，则使用通用类别。

如果...?​

任何更新日志条目都比没有好。如果你不确定是否选择了正确的类别，请使用“消息”字段简洁地描述你的更改。

这些条目被 @rnx-kit/rn-changelog-generator 脚本用于构建粗略草稿，然后由发布协调员编辑。

你的注释将用于将你的更改添加到最终发布说明中的正确位置。