跳到主要内容

拉取请求中的更新日志

拉取请求中的更新日志条目，作为您更改的“tl;dr”（太长不读）版本：它们是否影响 Android？这些是重大更改吗？是否添加了新内容？

使用标准化格式提供更新日志有助于发布协调员编写发布说明。请将更新日志作为您的拉取请求描述的一部分。如果拉取请求被合并，您的拉取请求描述将用作提交消息。

格式​

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

## Changelog:

[Category] [Type] - Message

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

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

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

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

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

更多详细信息，请参阅如何编写一份好的更新日志？和为什么要维护更新日志？

示例​

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

常见问题​

如果我的拉取请求同时包含 Android 和 JavaScript 的更改怎么办？​

使用 Android 类别。

如果我的拉取请求同时包含 Android 和 iOS 的更改怎么办？​

如果更改是在单个拉取请求中进行的，请使用通用类别。

如果我的拉取请求同时包含 Android、iOS 和 JavaScript 的更改怎么办？​

如果更改是在单个拉取请求中进行的，请使用通用类别。

如果...怎么办？​

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

这些条目由 @rnx-kit/rn-changelog-generator 脚本用于生成草稿，然后由发布协调员进行编辑。

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