跳到主要内容

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

常见问题解答​

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

使用 Android 类别。

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

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

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

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

如果...？​

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

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

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