更新日志格式

概述

RAPIDS 项目使用的更新日志流程概述。

目标受众

社区

开发者

项目负责人

流程

在每个 RAPIDS 发布的开发周期中,已合并的拉取请求将自动记录在 GitHub 的预发布版本中。预发布版本可在仓库的 GitHub 发布部分找到。(例如:https://github.com/rapidsai/cudf/releases)。在发布时,预发布版本正文的内容将被复制到每个仓库根目录下的 CHANGELOG.md 文件中。

正文

每个预发布版本正文包含按以下部分分类的拉取请求列表

  • 破坏性变更
  • 错误修复
  • 文档
  • 新功能
  • 改进

拉取请求标签

为了正确分类拉取请求,必须为每个请求应用以下标签

category 标签(选择一个)

在预发布版本中对拉取请求进行分类

  • 错误
  • 文档
  • 功能请求
  • 改进

breaking 标签(选择一个)

确定是否存在对用户功能的“破坏性”变更

注意:开发者应咨询其 PIC,以获取针对特定仓库的指南,用于确定“破坏性”变更

  • 破坏性
  • 非破坏性