From 9e8dbc0500e8589493b09e3229a532a13fee8708 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Mon, 19 Jul 2021 19:09:40 +0800 Subject: [PATCH 1/9] pr_template: Provides tips for cherry-pick --- .github/pull_request_template.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index beb41be5234e..09f988e8122c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,6 +12,19 @@ +**Tips for choosing the affected version(s):** + +- If your change fits one of the following situations, **CHOOSE MASTER ONLY**: + + - Relates to a documentation enhancement, such as supplementing missing or incomplete document contents. + - Fixes inaccurate or incorrect document contents, including values, descriptions, examples, or typos. + - Involves a documentation refactor in a specific topic module. + +- If your change fits one of the following situations, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**: + + - Involves a feature behavior change that relates to a specific version. + - Involves a compatibility change, including changing the default value of a configuration item or a system variable. + - [ ] master (the latest development version) - [ ] v5.1 (TiDB 5.1 versions) - [ ] v5.0 (TiDB 5.0 versions) From c8a99332a66d48115f7fffd03b6a67da6da16b0d Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Tue, 20 Jul 2021 16:46:56 +0800 Subject: [PATCH 2/9] address comment --- .github/pull_request_template.md | 12 +++--------- CONTRIBUTING.md | 17 ++++++++++++++++- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 09f988e8122c..f7bcc4696ffe 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,16 +14,10 @@ **Tips for choosing the affected version(s):** -- If your change fits one of the following situations, **CHOOSE MASTER ONLY**: +- If your change supplement missing or incomplete content, or fixes inaccurate or wrong contents, **CHOOSE MASTER ONLY**. +- If your change involves a version-specific feature behavior change or a compatibility change, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**. - - Relates to a documentation enhancement, such as supplementing missing or incomplete document contents. - - Fixes inaccurate or incorrect document contents, including values, descriptions, examples, or typos. - - Involves a documentation refactor in a specific topic module. - -- If your change fits one of the following situations, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**: - - - Involves a feature behavior change that relates to a specific version. - - Involves a compatibility change, including changing the default value of a configuration item or a system variable. +For details, see [tips for choosing the affected versions (in Chinese)](/CONTRIBUTING.md#版本选择指南). - [ ] master (the latest development version) - [ ] v5.1 (TiDB 5.1 versions) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9f5a6f685df..af4f12250ddd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ TiDB 文档的修改需要遵循一定的流程，具体如下。考虑到有些 > **注意：** > -> 目前 TiDB 主要维护以下几个版本的文档：dev（最新开发版）、v5.0、v4.0、v3.1、v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本，并据此修改所有相应的版本。 +> 目前 TiDB 主要维护以下几个版本的文档：dev（最新开发版）、v5.1、v5.0、v4.0、v3.1、v3.0 以及 v2.1。提 Pull Request 前请务必考虑修改会影响的文档版本，并据此修改所有相应的版本。选择版本时，请参考[版本选择指南](#版本选择指南)。 ### 第 0 步：签署 Contributor License Agreement @@ -194,6 +194,21 @@ TiDB 中文文档使用 Markdown 语言进行编写，为了保证文档质量 | `/cc` | 将 PR 分配给指定的 reviewer，需 @指定用户的 GitHub ID，多个 GitHub ID 间用逗号分隔。 | `/cc @TomShawn, @yikeke` | | `/uncc` | 移除 PR 之前指定的 reviewer。 | `/uncc @TomShawn`| +## 版本选择指南 + +如果你的 PR 改动符合以下任一情况，请**只选择 dev 版**： + +- 完善和优化文档内容，例如补充缺失或不完整的信息。 +- 修正不准确或错误的文档内容，例如默认值错误、描述不准确、示例错误、拼写错误等。 +- 重新组织现有文档的某个局部，例如“部署标准集群”、“数据迁移”、“TiDB 生态工具”等。 + +如果你的 PR 改动符合以下任一情况，请**选择 dev 版以及受影响的 release 版本**： + +- 涉及与版本相关的功能行为变化。 +- 涉及与版本相关的兼容性变化，例如更改某个配置项或变量的默认值。 +- 修复文档页面的渲染或显示错误。 +- 修复文档内的死链 + ## 联系我们 加入 Slack channel：[#sig-docs](https://slack.tidb.io/invite?team=tidb-community&channel=sig-docs&ref=pingcap-docs-cn) From e04a5bb93aaf99bbe8908438deaa68a5b118182e Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 13:44:08 +0800 Subject: [PATCH 3/9] Update CONTRIBUTING.md Co-authored-by: Grace Cai --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af4f12250ddd..9a0e3913b518 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -196,7 +196,7 @@ TiDB 中文文档使用 Markdown 语言进行编写，为了保证文档质量 ## 版本选择指南 -如果你的 PR 改动符合以下任一情况，请**只选择 dev 版**： +如果你的 PR 改动符合以下任一情况，推荐**只选择 dev 版**。此 PR 的改动在合并后将显示到 https://docs.pingcap.com/zh/tidb/dev/，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 - 完善和优化文档内容，例如补充缺失或不完整的信息。 - 修正不准确或错误的文档内容，例如默认值错误、描述不准确、示例错误、拼写错误等。 From 8deff58ac7a2c39e58af6a445d7f804a0d258fa2 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 13:46:07 +0800 Subject: [PATCH 4/9] Update .github/pull_request_template.md --- .github/pull_request_template.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f7bcc4696ffe..0e373c8d61d1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,8 +14,7 @@ **Tips for choosing the affected version(s):** -- If your change supplement missing or incomplete content, or fixes inaccurate or wrong contents, **CHOOSE MASTER ONLY**. -- If your change involves a version-specific feature behavior change or a compatibility change, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**. +By default, **CHOOSE MASTER ONLY** so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, **CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER**. For details, see [tips for choosing the affected versions (in Chinese)](/CONTRIBUTING.md#版本选择指南). From fbe806d26bc5a8916835640e35bd0d01ccad25e1 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 13:46:29 +0800 Subject: [PATCH 5/9] Update CONTRIBUTING.md Co-authored-by: Grace Cai --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a0e3913b518..1ac7dd4ad070 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -207,7 +207,7 @@ TiDB 中文文档使用 Markdown 语言进行编写，为了保证文档质量 - 涉及与版本相关的功能行为变化。 - 涉及与版本相关的兼容性变化，例如更改某个配置项或变量的默认值。 - 修复文档页面的渲染或显示错误。 -- 修复文档内的死链 +- 修复文档内的死链。 ## 联系我们 From 0346770d20bc6040350499de7d344f53b57e20aa Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 13:48:31 +0800 Subject: [PATCH 6/9] Update CONTRIBUTING.md Co-authored-by: Grace Cai --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ac7dd4ad070..a46af6af6c87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -196,7 +196,7 @@ TiDB 中文文档使用 Markdown 语言进行编写，为了保证文档质量 ## 版本选择指南 -如果你的 PR 改动符合以下任一情况，推荐**只选择 dev 版**。此 PR 的改动在合并后将显示到 https://docs.pingcap.com/zh/tidb/dev/，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 +如果你的 PR 改动符合以下任一情况，推荐**只选择 dev 版**。此 PR 的改动在合并后将显示到 [官网文档 Dev 页面](https://docs.pingcap.com/zh/tidb/dev/)，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 - 完善和优化文档内容，例如补充缺失或不完整的信息。 - 修正不准确或错误的文档内容，例如默认值错误、描述不准确、示例错误、拼写错误等。 From 42321368e0534429755fcfce0a1b3a30eddc1c39 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 13:49:07 +0800 Subject: [PATCH 7/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a46af6af6c87..a5f31b019627 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -196,7 +196,7 @@ TiDB 中文文档使用 Markdown 语言进行编写，为了保证文档质量 ## 版本选择指南 -如果你的 PR 改动符合以下任一情况，推荐**只选择 dev 版**。此 PR 的改动在合并后将显示到 [官网文档 Dev 页面](https://docs.pingcap.com/zh/tidb/dev/)，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 +如果你的 PR 改动符合以下任一情况，推荐**只选择 dev 版**。此 PR 的改动在合并后将显示到[官网文档 Dev 页面](https://docs.pingcap.com/zh/tidb/dev/)，在下一次 TiDB 发新版本时将显示到对应版本的文档页面。 - 完善和优化文档内容，例如补充缺失或不完整的信息。 - 修正不准确或错误的文档内容，例如默认值错误、描述不准确、示例错误、拼写错误等。 From 2ce8914f985e26bc015332e56d84803663a72181 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 23 Jul 2021 14:02:43 +0800 Subject: [PATCH 8/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5f31b019627..cf0c73d6d7d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ TiDB 文档的修改需要遵循一定的流程，具体如下。考虑到有些 > **注意：** > -> 目前 TiDB 主要维护以下几个版本的文档：dev（最新开发版）、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 From 505e94420e606936ceaaaa7f66d8923388048aaa 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 9/9] 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 cf0c73d6d7d8..3c9bba7dfa4f 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 分支**： - 涉及与版本相关的功能行为变化。 - 涉及与版本相关的兼容性变化，例如更改某个配置项或变量的默认值。