跳至主要内容

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 脚本用于构建粗略草稿，然后由版本协调员进行编辑。

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