Skip to content
This repository has been archived by the owner on Dec 8, 2021. It is now read-only.

Commit

Permalink
.github: add issue templates (#124)
Browse files Browse the repository at this point in the history
* add bug-report template

* add feature-request template

* add question template
  • Loading branch information
lonng committed Jan 21, 2019
1 parent 77fa23f commit 117c24b
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,59 @@
---
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

- TiDB-Lightning version (run `tidb-lightning -V`):

```
(paste TiDB-Lightning version here)
```
- TiKV-Importer version (run `tikv-importer -V`)

```
(paste TiKV-Importer version here)
```
- TiKV version (run `tikv-server -V`):

```
(paste TiKV version here)
```

- TiDB cluster version (execute `SELECT tidb_version();` in a MySQL client):

```
(paste TiDB cluster version here)
```

- Other interesting information (system version, hardware config, etc):

>
>
5. Operation logs
- Please upload `tidb-lightning.log` for TiDB-Lightning if possible
- Please upload `tikv-importer.log` from TiKV-Importer if possible
- Other interesting logs

6. Configuration of the cluster and the task
- `tidb-lightning.toml` for TiDB-Lightning if possible
- `tikv-importer.toml` for TiKV-Importer if possible
- `inventory.ini` if deployed by Ansible

7. Screenshot/exported-PDF of Grafana dashboard or metrics' graph in Prometheus for TiDB-Lightning if possible
20 changes: 20 additions & 0 deletions .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, Optimization:**
<!-- 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
@@ -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/tidb-lightning/issues?q=is%3Aissue)
- Read the documentation:
* [Detailed documentation](https://pingcap.com/docs/tools/lightning/overview-architecture/)
* [简体中文文档](https://pingcap.com/docs-cn/tools/lightning/overview-architecture/)

0 comments on commit 117c24b

Please sign in to comment.