From 035604580d44c25e47dc4c25f11903133e4d478b Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 14:24:44 +0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Grace Cai --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf5a9083feb4..62d7a5ae2d99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ TiDB 文档的修改需要遵循一定的流程，具体如下。考虑到有些 > **注意：** > -> 目前 TiDB 主要维护以下几个版本的文档：dev（最新开发版，对应 master 分支）、v5.1、v5.0、v4.0、v3.1、v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本，并据此修改所有相应的版本。选择版本时，请参考[版本选择指南](#版本选择指南)。 +> 目前 TiDB 主要维护以下几个版本的文档：dev（最新开发版，对应文档仓库的 master 分支）、v5.1、v5.0、v4.0、v3.1、v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本，并据此修改所有相应的版本。选择版本时，请参考[版本选择指南](#版本选择指南)。 ### 第 0 步：签署 Contributor License Agreement @@ -196,13 +196,15 @@ TiDB 中文文档使用 Markdown 语言进行编写，为了保证文档质量 ## 版本选择指南 -如果你的 PR 改动符合以下任一情况，推荐**只选择 dev 版**。此 PR 的改动在合并后将显示到[官网文档 Dev 页面](https://docs.pingcap.com/zh/tidb/dev/)，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 +创建 Pull Request 时，你需要在 Pull Request 的描述模版中选择文档改动适用的版本分支。 + +如果你的 PR 改动符合以下任一情况，推荐**只选择 master 分支**。此 PR 的改动在合并后将显示到[官网文档 Dev 页面](https://docs.pingcap.com/zh/tidb/dev/)，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 - 完善和优化文档内容，例如补充缺失或不完整的信息。 - 修正不准确或错误的文档内容，例如默认值错误、描述不准确、示例错误、拼写错误等。 - 重新组织现有文档的某个局部，例如“部署标准集群”、“数据迁移”、“TiDB 生态工具”等。 -如果你的 PR 改动符合以下任一情况，请**选择 dev 版以及受影响的 release 版本**： +如果你的 PR 改动符合以下任一情况，请**选择 master 分支以及受影响的 release 分支**： - 涉及与版本相关的功能行为变化。 - 涉及与版本相关的兼容性变化，例如更改某个配置项或变量的默认值。