Skip to content

Commit

Permalink
update PR template for v5.2 (#6166)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomShawn authored Aug 25, 2021
1 parent 3fcb824 commit fe0fef1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ By default, **CHOOSE MASTER ONLY** so your changes will be applied to the next T
For details, see [tips for choosing the affected versions](https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md#guideline-for-choosing-the-affected-versions).

- [ ] master (the latest development version)
- [ ] v5.2 (TiDB 5.2 versions)
- [ ] v5.1 (TiDB 5.1 versions)
- [ ] v5.0 (TiDB 5.0 versions)
- [ ] v4.0 (TiDB 4.0 versions)
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@ Before you contribute, please take a quick look at some general information abou

### Learn about docs versions

Currently, we maintain seven versions of TiDB documentation, each with a separate branch:
Currently, we maintain the following versions of TiDB documentation, each with a separate branch:

| Docs branch name | Version description |
| :--- | :--- |
| `master` branch | the latest development version |
| `release-5.2` branch | the 5.2 stable version |
| `release-5.1` branch | the 5.1 stable version |
| `release-5.0` branch | the 5.0 stable version |
| `release-4.0` branch | the 4.0 stable version |
Expand All @@ -52,6 +53,7 @@ Currently, we maintain seven versions of TiDB documentation, each with a separat
- If your changes apply to only one docs version, just submit a PR to the corresponding version branch.

- If your changes apply to multiple docs versions, you don't have to submit a PR to each branch. Instead, after you submit your PR, trigger the ti-chi-bot to submit a PR to other version branches by adding one or several of the following labels as needed. Once the current PR is merged, ti-chi-bot will start to work.
- `needs-cherry-pick-5.2` label: ti-chi-bot will submit a PR to the `release-5.2` branch.
- `needs-cherry-pick-5.1` label: ti-chi-bot will submit a PR to the `release-5.1` branch.
- `needs-cherry-pick-5.0` label: ti-chi-bot will submit a PR to the `release-5.0` branch.
- `needs-cherry-pick-4.0` label: ti-chi-bot will submit a PR to the `release-4.0` branch.
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Currently, we maintain the following versions of TiDB documentation in different
| Branch name | TiDB docs version |
| :---------|:----------|
| [`master`](https://github.com/pingcap/docs/tree/master) | The latest development version |
| [`release-5.1`](https://github.com/pingcap/docs/tree/release-5.1) | 5.1 version |
| [`release-5.2`](https://github.com/pingcap/docs/tree/release-5.2) | 5.2 stable version |
| [`release-5.1`](https://github.com/pingcap/docs/tree/release-5.1) | 5.1 stable version |
| [`release-5.0`](https://github.com/pingcap/docs/tree/release-5.0) | 5.0 stable version |
| [`release-4.0`](https://github.com/pingcap/docs/tree/release-4.0) | 4.0 stable version |
| [`release-3.1`](https://github.com/pingcap/docs/tree/release-3.1) | 3.1 stable version |
Expand Down

0 comments on commit fe0fef1

Please sign in to comment.