Skip to content

Commit

Permalink
feat: improve Issue templates with Form Schema
Browse files Browse the repository at this point in the history
Signed-off-by: 诺墨 <[email protected]>
  • Loading branch information
normal-coder committed Jul 28, 2023
1 parent c0f7782 commit 3661260
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 55 deletions.
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: Bug Report
description: Create a report to help us improve
title: '[Bug]: '
labels:
- bug
assignees: []

body:
- type: input
id: Bug-describe
attributes:
label: Describe the bug
placeholder: 'A clear and concise description of the error in one sentence.'
validations:
required: true

- type: textarea
id: Reproduce
attributes:
label: Steps to Reproduce
placeholder: |
If applicable, add screenshots to help explain your problem.
Provide steps to reproduce the behavior. eg:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
placeholder: 'A clear and concise description of what you expected to happen.'

- type: dropdown
id: App-Version
attributes:
label: Please select the app version
description: 'If there is no matching option, please provide the specific version number in the description'
options:
- 0.5.0
- 0.4.1
- 0.4.0
- 0.3.0
- 0.2.1
- 0.2.0
- 0.1.0
- Older version
validations:
required: true

- type: dropdown
id: Platform-or-OS-Type
attributes:
label: Please select the Platform / OS Type
options:
- Darwin(macOS)
- Windows
- Linux
- Other
multiple: true
validations:
required: true

- type: input
id: OS-Version
attributes:
label: Please provide your OS version, eg 13.3.1
validations:
required: true

- type: dropdown
id: OS-Arch
attributes:
label: Please select the OS Arch you are using when encounter the problem
multiple: true
options:
- x86
- x86_64
- arm
- arm64(aarch64)
- Other
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
placeholder: 'Add any other context about the problem here.'

- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug report."
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature request
description: Suggest an idea for this project
title: '[Feature]: '
labels:
- feature
assignees: []

body:
- type: textarea
id: Problem-related
attributes:
label: Is your feature request related to a problem? Please describe.
placeholder: |
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: Solution
attributes:
label: Describe the solution you'd like
placeholder: |
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
placeholder: |
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true

- type: textarea
id: Additional-context
attributes:
label: Additional context
placeholder: |
Add any other context or screenshots about the feature request here.
validations:
required: true

- type: markdown
attributes:
value: "Thanks for taking the time to fill out this feature request."

0 comments on commit 3661260

Please sign in to comment.