From 55ab06a5397a24907c3725ba4b08cb2869f221f3 Mon Sep 17 00:00:00 2001 From: tennix <ztennix@gmail.com> Date: Tue, 23 Apr 2019 17:24:16 +0800 Subject: [PATCH 1/3] add GitHub templates for issue reporting and PR --- .github/ISSUE_TEMPLATE/bug-report.md | 29 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 19 ++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 16 ++++++++++++ .github/pull_request_template.md | 32 +++++++++++++++++++++++ 4 files changed, 96 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000000..0d166c1dbf0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,29 @@ +--- +name: "\U0001F41B Bug Report" +about: Something isn't working as expected + +--- + +## Bug Report + +**What version of Kubernetes are you using?** +<!-- You can run `kubectl version` --> + +**What storage classes exist in the Kubernetes cluster?** +<!-- You can run `kubectl get sc` --> + +**What version of TiDB Operator are you using?** +<!-- You can run `kubectl exec -n tidb-admin {tidb-controller-manager-pod-name} -- tidb-controller-manager -V` --> + +**What storage classes are used for PD and TiKV?** +<!-- You can run `kubectl get pvc -n {tidb-cluster-namespace}` --> + +**What's the status of the TiDB cluster pods?** +<!-- You can run `kubectl get po -n {tidb-cluster-namespace} -o wide` --> + +**What did you do?** +<!-- If possible, provide a recipe for reproducing the error. A complete runnable program is good. --> + +**What did you expect to see?** + +**What did you see instead?** diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000000..cb6e994f6d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,19 @@ +--- +name: "\U0001F680 Feature Request" +about: I have a suggestion + +--- + +## Feature Request + +**Is your feature request related to a problem? Please describe:** +<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> + +**Describe the feature you'd like:** +<!-- A clear and concise description of what you want to happen. --> + +**Describe alternatives you've considered:** +<!-- A clear and concise description of any alternative solutions or features you've considered. --> + +**Teachability, Documentation, Adoption, Migration Strategy:** +<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. --> diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000000..889b3bcbb1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,16 @@ +--- +name: "\U0001F914 Question" +about: Usage question that isn't answered in docs or discussion + +--- + +## Question + +Before asking a question, make sure you have: + +- Searched existing Stack Overflow questions. +- Googled your question. +- Searched open and closed [GitHub issues](https://github.com/pingcap/tidb-operator/issues?utf8=%E2%9C%93&q=is%3Aissue) +- Read the documentation: + - [TiDB Operator Readme](https://github.com/pingcap/tidb-operator) + - [TiDB Operator Doc](https://github.com/pingcap/tidb-operator/tree/master/docs) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000000..739d409d568 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +<!-- +Thank you for contributing to TiDB Operator! Please read TiDB Operator's [CONTRIBUTING](https://github.com/pingcap/tidb-operator/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR. +--> + +### What problem does this PR solve? <!--add issue link with summary if exists--> + +### What is changed and how it works? + +### Check List <!--REMOVE the items that are not applicable--> + +Tests <!-- At least one of them must be included. --> + + - Unit test + - E2E test + - Manual test (add detailed scripts or steps below) + - No code + +Code changes + + - Has Helm charts change + - Has Go code change + - Has CI related scripts change + +Side effects + + - Increased code complexity + - Breaking backward compatibility + +Related changes + + - Need to cherry-pick to the release branch + - Need to update the documentation From 350d05a682fbb4417b30d49872d108e2427f7bfe Mon Sep 17 00:00:00 2001 From: tennix <ztennix@gmail.com> Date: Wed, 24 Apr 2019 15:59:25 +0800 Subject: [PATCH 2/3] address comments --- .github/ISSUE_TEMPLATE/bug-report.md | 9 +++------ .github/ISSUE_TEMPLATE/question.md | 3 +-- .github/pull_request_template.md | 2 +- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 0d166c1dbf0..c926c024d98 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -9,20 +9,17 @@ about: Something isn't working as expected **What version of Kubernetes are you using?** <!-- You can run `kubectl version` --> -**What storage classes exist in the Kubernetes cluster?** -<!-- You can run `kubectl get sc` --> - **What version of TiDB Operator are you using?** <!-- You can run `kubectl exec -n tidb-admin {tidb-controller-manager-pod-name} -- tidb-controller-manager -V` --> -**What storage classes are used for PD and TiKV?** -<!-- You can run `kubectl get pvc -n {tidb-cluster-namespace}` --> +**What storage classes exist in the Kubernetes cluster and what are used for PD/TiKV pods?** +<!-- You can run `kubectl get sc` and `kubectl get pvc -n {tidb-cluster-namespace}` --> **What's the status of the TiDB cluster pods?** <!-- You can run `kubectl get po -n {tidb-cluster-namespace} -o wide` --> **What did you do?** -<!-- If possible, provide a recipe for reproducing the error. A complete runnable program is good. --> +<!-- If possible, provide a recipe for reproducing the error. How you installed tidb-operator and tidb-cluster. --> **What did you expect to see?** diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 889b3bcbb1c..5235d3b2ab9 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -8,8 +8,7 @@ about: Usage question that isn't answered in docs or discussion Before asking a question, make sure you have: -- Searched existing Stack Overflow questions. -- Googled your question. +- Reviewed relevant Kubernetes information: Google your error messages and look at K8s docs. - Searched open and closed [GitHub issues](https://github.com/pingcap/tidb-operator/issues?utf8=%E2%9C%93&q=is%3Aissue) - Read the documentation: - [TiDB Operator Readme](https://github.com/pingcap/tidb-operator) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 739d409d568..d77f7c08bb9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,10 +20,10 @@ Code changes - Has Helm charts change - Has Go code change - Has CI related scripts change + - Has documents change Side effects - - Increased code complexity - Breaking backward compatibility Related changes From 1686f9efc28ff89e13f1f0bd178fa6681996a83d Mon Sep 17 00:00:00 2001 From: tennix <ztennix@gmail.com> Date: Thu, 25 Apr 2019 20:07:49 +0800 Subject: [PATCH 3/3] address comment --- .github/pull_request_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d77f7c08bb9..1750edf8983 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,7 @@ Thank you for contributing to TiDB Operator! Please read TiDB Operator's [CONTRIBUTING](https://github.com/pingcap/tidb-operator/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR. --> -### What problem does this PR solve? <!--add issue link with summary if exists--> +### What problem does this PR solve? <!--add and issue link with summary if exists--> ### What is changed and how it works? @@ -12,6 +12,7 @@ Tests <!-- At least one of them must be included. --> - Unit test - E2E test + - Stability test - Manual test (add detailed scripts or steps below) - No code