From 67d070d9f37401c78c1c696e0db745a098b1c2be Mon Sep 17 00:00:00 2001
From: Xuecheng Zhang <csuzhangxc@gmail.com>
Date: Mon, 21 Jan 2019 11:34:04 +0800
Subject: [PATCH] .github: add issue templates (#17)

---
 .github/ISSUE_TEMPLATE/bug-report.md      | 63 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature-request.md | 20 +++++++
 .github/ISSUE_TEMPLATE/question.md        | 17 ++++++
 3 files changed, 100 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

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 0000000000..e79f7e360e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,63 @@
+---
+name: "\U0001F41B Bug Report"
+labels: "bug"
+about: Something isn't working as expected
+
+---
+
+## Bug Report
+
+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. Versions of the cluster
+
+    - DM version (run `dmctl -V` or `dm-worker -V` or `dm-master -V`):
+
+        ```
+        (paste DM version here, and you must ensure versions of dmctl, DM-worker and DM-master are same)
+        ```
+
+    - Upstream MySQL/MariaDB server version:
+
+        ```
+        (paste upstream MySQL/MariaDB server version here)
+        ```
+
+    - Downstream TiDB cluster version (execute `SELECT tidb_version();` in a MySQL client):
+
+        ```
+        (paste TiDB cluster version here)
+        ```
+
+    - How did you deploy DM: DM-Ansible or manually?
+
+        ```
+        (leave DM-Ansible or manually here)
+        ```
+
+    - Other interesting information (system version, hardware config, etc):
+
+        >
+        >
+
+5. current status of DM cluster (execute `query-status` in dmctl)
+
+6. Operation logs
+   - Please upload `dm-worker.log` for every DM-worker instance if possible
+   - Please upload `dm-master.log` if possible
+   - Other interesting logs
+   - Output of dmctl's commands with problems
+   
+7. Configuration of the cluster and the task
+   - `dm-worker.toml` for every DM-worker instance if possible
+   - `dm-master.toml` for DM-master if possible
+   - task config, like `task.yaml` if possible
+   - `inventory.ini` if deployed by DM-Ansible
+
+8. Screenshot/exported-PDF of Grafana dashboard or metrics' graph in Prometheus for DM if possible
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
new file mode 100644
index 0000000000..d98eda7f54
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,20 @@
+---
+name: "\U0001F680 Feature Request"
+labels: "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. -->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 0000000000..88e8c4dc9c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,17 @@
+---
+name: "\U0001F914 Question"
+labels: "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/dm/issues?q=is%3Aissue)
+- Read the documentation:
+    - [Detailed documentation](https://pingcap.com/docs/tools/data-migration-overview/)
+    - [简体中文文档](https://github.com/pingcap/tidb-tools/blob/docs/docs/dm/zh_CN/README.md)