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

Commit

Permalink
use yml template to get better experience (#355)
Browse files Browse the repository at this point in the history
  • Loading branch information
docsir authored Oct 11, 2021
1 parent 562cb6c commit 0ea86cd
Show file tree
Hide file tree
Showing 8 changed files with 184 additions and 113 deletions.
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: "\U0001F41B Bug Report"
description: Something isn't working as expected
labels: ["type/bug"]
body:
- type: markdown
attributes:
value: |
Please answer these questions before submitting your issue. Thanks!
- type: textarea
id: problem
attributes:
label: What did you do?
description: If possible, provide a recipe for reproducing the error.
validations:
required: true
- type: textarea
id: expect
attributes:
label: What did you expect to see?
validations:
required: false
- type: textarea
id: see
attributes:
label: What did you see instead?
validations:
required: false
- type: textarea
id: version
attributes:
label: Versions of the cluster
value: |-
Dumpling version (run `dumpling -V`):
```console
(paste Dumpling version here)
```
Source database version (execute `SELECT version();` in a MySQL client):
```console
(paste source database version here)
```
Other interesting information (system version, hardware config, etc):
```console
>
>
```
validations:
required: true
- type: markdown
attributes:
value: |
Operation logs
- Please upload `dumpling.log` for Dumpling if possible
- Other interesting logs
- type: markdown
attributes:
value: |
Configuration of the cluster and the task
- running command for Dumpling if possible

37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/challenge-program.md

This file was deleted.

63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/challenge-program.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: "\U0001F947 Propose a Challenge Program task with no theme"
description: As a developer, I want to propose a Challenge Program task with no theme.
labels: ["challenge-program"]
body:
- type: markdown
attributes:
value: |
If you want to specify a special theme challenge program task, please add the theme label to the issue(`challenge-program`+`{some-theme-label}`).
Current support theme labels:
- hptc
- high-performance
- type: textarea
id: description
attributes:
label: Description
value: |-
issue background
validations:
required: true
- type: textarea
id: tasks
attributes:
label: Tasks
value: |-
- task 1
- task 2
- task 3
validations:
required: true
- type: textarea
id: score
attributes:
label: Score
value: |-
score number
validations:
required: true
- type: textarea
id: mentor
attributes:
label: Mentor
value: |-
- @mentor
validations:
required: true
- type: textarea
id: skills
attributes:
label: Recommended Skills
value: |-
- skill 1
- skill 2
- skill 3
validations:
required: true
- type: textarea
id: materials
attributes:
label: Learning Materials
validations:
required: false


19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: "\U0001F680 Feature Request"
description: I have a suggestion
labels: ["feature-request"]
body:
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: expect
attributes:
label: Describe the feature you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: more
attributes:
label: Teachability, Documentation, Adoption, Optimization
description: 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.
validations:
required: false


16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: "\U0001F914 Question"
description: Usage question that isn't answered in docs or discussion
labels: ["question"]
body:
- type: checkboxes
id: terms
attributes:
label: Before asking a question, make sure you have
options:
- label: Searched existing Stack Overflow questions
required: true
- label: Googled your question
required: true
- label: Searched open and closed [GitHub issues](https://github.com/pingcap/dumpling/issues?q=is%3Aissue)
required: true
- label: Read the documentation
- [Detailed documentation](https://github.com/pingcap/dumpling/blob/master/docs/en/user-guide.md)
- [简体中文文档](https://github.com/pingcap/dumpling/blob/master/docs/cn/user-guide.md)
required: true
- type: textarea
id: question
attributes:
label: What is your question?
validations:
required: true


0 comments on commit 0ea86cd

Please sign in to comment.