跳到主要内容

拉取请求中的更新日志

你的 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 中的崩溃

常见问题​

如果我的 Pull Request 包含对 Android 和 JavaScript 的更改怎么办？​

使用 Android 类别。

如果我的 Pull Request 包含对 Android 和 iOS 的更改怎么办？​

如果更改在单个 Pull Request 中完成，请使用通用类别。

如果我的 Pull Request 包含对 Android、iOS 和 JavaScript 的更改怎么办？​

如果更改在单个 Pull Request 中完成，请使用通用类别。

如果...？​

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

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

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