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.

Sign up for GitHub

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

Jump to bottom

*: update guiding resources #2165

Merged
merged 1 commit into from
Apr 4, 2020
Merged

*: update guiding resources #2165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@

<!--Tick the checkbox(es) below to choose the TiDB version(s) that your changes apply to.-->

- [ ] master (the latest development version, including v4.0 changes for now)
- [ ] master (the latest development version)
- [ ] v4.0 (TiDB 4.0 versions)
- [ ] v3.1 (TiDB 3.1 versions)
- [ ] v3.0 (TiDB 3.0 versions)
- [ ] v2.1 (TiDB 2.1 versions)

**If you select two or more versions from above**, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you **must** add corresponding labels such as **needs-cherry-pick-3.1**, **needs-cherry-pick-3.0**, and **needs-cherry-pick-2.1**.
**If you select two or more versions from above**, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you **must** add corresponding labels such as **needs-cherry-pick-4.0**, **needs-cherry-pick-3.1**, **needs-cherry-pick-3.0**, and **needs-cherry-pick-2.1**.

### What is the related PR or file link(s)?

Expand Down
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ Currently, we maintain four versions of TiDB documentation, each with a separate
| Docs branch name | Version description |
| :--- | :--- |
| `master` branch | the latest development version |
| `release-3.1` branch | the 3.1 Beta version |
| `release-3.0` branch | the latest 3.0 stable version |
| `release-2.1` branch | the latest 2.1 stable version |
| `release-4.0` branch | the 4.0 Beta version |
| `release-3.1` branch | the 3.1 RC version |
| `release-3.0` branch | the 3.0 stable version |
| `release-2.1` branch | the 2.1 stable version |

> **Note:**
>
Expand All @@ -50,8 +51,9 @@ Currently, we maintain four versions of TiDB documentation, each with a separate

- 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 sre-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, sre-bot will start to work.

- `needs-cherry-pick-3.0` label: sre-bot will submit a PR to the `release-3.0` branch.
- `needs-cherry-pick-4.0` label: sre-bot will submit a PR to the `release-4.0` branch.
- `needs-cherry-pick-3.1` label: sre-bot will submit a PR to the `release-3.1` branch.
- `needs-cherry-pick-3.0` label: sre-bot will submit a PR to the `release-3.0` branch.
- `needs-cherry-pick-2.1` label: sre-bot will submit a PR to the `release-2.1` branch.

- If most of your changes apply to multiple docs versions but some differences exist among versions, you still can use cherry-pick labels to let sre-bot create PRs to other versions. After the PR to another version is successfully submitted by sre-bot, you can make changes to that PR.
Expand Down