Skip to content
This repository has been archived by the owner on Nov 24, 2023. It is now read-only.

Commit

Permalink
.github: add issue templates (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
csuzhangxc authored Jan 21, 2019
1 parent 66fa3eb commit 67d070d
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -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. -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 67d070d

Please sign in to comment.