From 992191c0b9344c4905eb3330c97d580f48464f92 Mon Sep 17 00:00:00 2001 From: Neil Shen Date: Wed, 15 Jan 2020 18:02:58 +0800 Subject: [PATCH 1/2] *: add change log and github templates Signed-off-by: Neil Shen --- .github/ISSUE_TEMPLATE/bug-report.md | 23 ++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 19 ++++++++++++ .github/pull_request_template.md | 37 +++++++++++++++++++++++ CHANGELOG.md | 18 +++++++++++ 4 files changed, 97 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/pull_request_template.md create mode 100644 CHANGELOG.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..8c66ec659 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,23 @@ +--- +name: "🐛 Bug Report" +about: Something isn't working as expected +title: '' +labels: 'bug' +--- + +Please answer these questions before submitting your issue. Thanks! + +1. What did you do? +If possible, provide a recipe for reproducing the error. + + +2. What did you expect to see? + + + +3. What did you see instead? + + + +4. What version of PD are you using (`br version`)? + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..e895af84d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,19 @@ +--- +name: "🚀 Feature Request" +about: I have a suggestion +labels: enhancement +--- + +## Feature Request + +### Describe your feature request related problem: + + +### Describe the feature you'd like: + + +### Describe alternatives you've considered: + + +### Teachability, Documentation, Adoption, Migration Strategy: + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..0f6ae8de0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ + + +### What problem does this PR solve? + + +### What is changed and how it works? + + +### Check List + +Tests + + - Unit test + - Integration test + - Manual test (add detailed scripts or steps below) + - No code + +Code changes + + - Has exported function/method change + - Has exported variable/fields change + - Has interface methods change + - Has persistent data change + +Side effects + + - Possible performance regression + - Increased code complexity + - Breaking backward compatibility + +Related changes + + - Need to cherry-pick to the release branch + - Need to update the documentation + - Need to be included in the release note diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..3648f3bc2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# BR (Backup and Restore) Change Log +All notable changes to this project are documented in this file. +See also, +- [TiDB Changelog](https://github.com/pingcap/tidb/blob/master/CHANGELOG.md), +- [TiKV Changelog](https://github.com/tikv/tikv/blob/master/CHANGELOG.md), +- [PD Changelog](https://github.com/pingcap/pd/blob/master/CHANGELOG.md). + +## [3.1.0-beta.1] - 2020-1-10 + +- Fix the inaccurate backup progress information [#127](https://github.com/pingcap/br/pull/127) +- Improve the performance of splitting Regions [#122](https://github.com/pingcap/br/pull/122) +- Add the backup and restore feature for partitioned tables [#137](https://github.com/pingcap/br/pull/137) +- Add the feature of automatically scheduling PD schedulers [#123](https://github.com/pingcap/br/pull/123) +- Fix the issue that data is overwritten after non `PKIsHandle` tables are restored [#139](https://github.com/pingcap/br/pull/139) + +## [3.1.0-beta] - 2019-12-20 + +Initial release of the distributed backup and restore tool From 85a82557e87c8d083ed338ba4a163964ce52d677 Mon Sep 17 00:00:00 2001 From: Neil Shen Date: Thu, 16 Jan 2020 14:32:30 +0800 Subject: [PATCH 2/2] address comments Signed-off-by: Neil Shen --- .github/ISSUE_TEMPLATE/bug-report.md | 10 ++++++++-- CHANGELOG.md | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 8c66ec659..872699919 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -19,5 +19,11 @@ If possible, provide a recipe for reproducing the error. -4. What version of PD are you using (`br version`)? - +4. What version of BR and TiDB/TiKV/PD are you using? + + diff --git a/CHANGELOG.md b/CHANGELOG.md index 3648f3bc2..6db4cfd21 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ See also, - [TiKV Changelog](https://github.com/tikv/tikv/blob/master/CHANGELOG.md), - [PD Changelog](https://github.com/pingcap/pd/blob/master/CHANGELOG.md). -## [3.1.0-beta.1] - 2020-1-10 +## [3.1.0-beta.1] - 2020-01-10 - Fix the inaccurate backup progress information [#127](https://github.com/pingcap/br/pull/127) - Improve the performance of splitting Regions [#122](https://github.com/pingcap/br/pull/122)