diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000000..c926c024d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,26 @@ +--- +name: "\U0001F41B Bug Report" +about: Something isn't working as expected + +--- + +## Bug Report + +**What version of Kubernetes are you using?** + + +**What version of TiDB Operator are you using?** + + +**What storage classes exist in the Kubernetes cluster and what are used for PD/TiKV pods?** + + +**What's the status of the TiDB cluster pods?** + + +**What did you do?** + + +**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 0000000000..cb6e994f6d --- /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:** + + +**Describe the feature you'd like:** + + +**Describe alternatives you've considered:** + + +**Teachability, Documentation, Adoption, Migration Strategy:** + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..5235d3b2ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,15 @@ +--- +name: "\U0001F914 Question" +about: Usage question that isn't answered in docs or discussion + +--- + +## Question + +Before asking a question, make sure you have: + +- 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) + - [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 0000000000..1750edf898 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,33 @@ + + +### What problem does this PR solve? + +### What is changed and how it works? + +### Check List + +Tests + + - Unit test + - E2E test + - Stability 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 + - Has documents change + +Side effects + + - Breaking backward compatibility + +Related changes + + - Need to cherry-pick to the release branch + - Need to update the documentation