跳到主要内容

拉取请求中的更新日志

您 Pull Request 中的变更日志条目就像您所做更改的“摘要”：它们会影响 Android 吗？这些是破坏性更改吗？是否有新增内容？

提供符合标准化格式的变更日志有助于发布协调员撰写发布说明。请在您的 Pull Request 描述中包含变更日志。如果 Pull Request 被合并，您的 Pull Request 描述将用作提交消息。

格式​

变更日志条目的格式如下

## Changelog:

[Category] [Type] - Message

"类别" 字段可以是以下之一

  • Android，适用于影响 Android 的更改。
  • iOS，适用于影响 iOS 的更改。
  • General，适用于不符合其他任何类别的更改。
  • Internal，适用于与使用发布说明的开发者无关的更改。

"类型" 字段可以是以下之一

  • Breaking，适用于破坏性更改。
  • Added，适用于新功能。
  • Changed，适用于现有功能的更改。
  • Deprecated，适用于即将移除的功能。
  • Removed，适用于已移除的功能。
  • Fixed，适用于任何错误修复。
  • Security，适用于安全漏洞。

最后，“消息”字段可以回答“什么和为什么”的功能级别问题。使用此字段简要告知 React Native 用户重要的更改。

有关更多详细信息，请参阅 如何写好变更日志？ 和 为什么要维护变更日志？

示例​

  • [General] [Added] - 为 ScrollView 组件添加 snapToOffsets 属性
  • [General] [Fixed] - 修复 ScrollView 组件中 snapToInterval 的各种问题
  • [iOS] [Fixed] - 修复 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 脚本用于构建草稿，然后由发布协调员进行编辑。

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