Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pr_template: Provides tips for cherry-pick #6702

Merged
merged 9 commits into from
Jul 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@

<!-- Fill in "x" in [] to tick the checkbox below.-->

**Tips for choosing the affected version(s):**

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#版本选择指南).

- [ ] master (the latest development version)
- [ ] v5.1 (TiDB 5.1 versions)
- [ ] v5.0 (TiDB 5.0 versions)
Expand Down
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ TiDB 文档的修改需要遵循一定的流程,具体如下。考虑到有些

> **注意:**
>
> 目前 TiDB 主要维护以下几个版本的文档:dev(最新开发版)、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

Expand Down Expand Up @@ -194,6 +194,23 @@ TiDB 中文文档使用 Markdown 语言进行编写,为了保证文档质量
| `/cc` | 将 PR 分配给指定的 reviewer,需 @指定用户的 GitHub ID,多个 GitHub ID 间用逗号分隔。 | `/cc @TomShawn, @yikeke` |
| `/uncc` | 移除 PR 之前指定的 reviewer。 | `/uncc @TomShawn`|

## 版本选择指南

TomShawn marked this conversation as resolved.
Show resolved Hide resolved
创建 Pull Request 时,你需要在 Pull Request 的描述模版中选择文档改动适用的版本分支。

如果你的 PR 改动符合以下任一情况,推荐**只选择 master 分支**。此 PR 的改动在合并后将显示到[官网文档 Dev 页面](https://docs.pingcap.com/zh/tidb/dev/),在下一次 TiDB 发新版本时将显示到对应版本的文档页面。

- 完善和优化文档内容,例如补充缺失或不完整的信息。
- 修正不准确或错误的文档内容,例如默认值错误、描述不准确、示例错误、拼写错误等。
- 重新组织现有文档的某个局部,例如“部署标准集群”、“数据迁移”、“TiDB 生态工具”等。

如果你的 PR 改动符合以下任一情况,请**选择 master 分支以及受影响的 release 分支**:

- 涉及与版本相关的功能行为变化。
- 涉及与版本相关的兼容性变化,例如更改某个配置项或变量的默认值。
- 修复文档页面的渲染或显示错误。
- 修复文档内的死链。

## 联系我们

加入 Slack channel:[#sig-docs](https://slack.tidb.io/invite?team=tidb-community&channel=sig-docs&ref=pingcap-docs-cn)