Skip to content

Commit 3fb54b8

Browse files
ttytmttytm
committed
ci: add issue templates to facilitate the faster resolution of reports
1 parent f1f54a9 commit 3fb54b8

File tree

3 files changed

+159
-0
lines changed

3 files changed

+159
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report.
3+
labels: [bug]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thanks for taking the time to fill out this bug report!
9+
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Describe the Bug
14+
description: What happened? A clear and concise description of the bug.
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: expected
20+
attributes:
21+
label: Expected Behavior
22+
description: What did you expect to happened?
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: reproduction
28+
attributes:
29+
label: Reproduction Steps
30+
description: |
31+
Providing a self-contained, concise code example that can be used to reproduce the issue.
32+
Can help to solve the problem as fast as possible.
33+
34+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
35+
36+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
37+
The code sample should be an SSCCE. See http://sscce.org/ for details.
38+
In short, please provide a code sample that we can copy/paste, run and reproduce.
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
id: logs
44+
attributes:
45+
label: Error Logs
46+
render: 'shell'
47+
description: |
48+
Please include full errors, uncaught exceptions, stack traces.
49+
Trigger the issue with WebUI's debug build to add relevant logs.
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: suggestion
55+
attributes:
56+
label: Possible Solution
57+
description: If you can suggest fix, include a prototype/workaround/sketch/reference.
58+
validations:
59+
required: false
60+
61+
- type: input
62+
id: version
63+
attributes:
64+
label: Version
65+
description: Please provide the current WebUI version you are using.
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: environment
71+
attributes:
72+
label: Environment details (OS name and version, etc.)
73+
render: shell
74+
description: |
75+
To fill in this section, you can use on Unix-like systems:
76+
```sh
77+
uname -somr
78+
```
79+
On Windows you can use:
80+
```sh
81+
cmd /c wmic cpu get systemname,caption
82+
```
83+
validations:
84+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: 💬 WebUI Community Support
5+
url: https://github.com/webui-dev/webui/discussions
6+
about: Please can ask and answer questions about WebUI here.

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: 🚀 Feature Request
2+
description: Suggest an idea for this project.
3+
labels: [enhancement]
4+
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the Feature
10+
description: A clear and concise description of the feature you are proposing.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: use-case
16+
attributes:
17+
label: Use Case
18+
description: Why do you need this feature?
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: suggestion
24+
attributes:
25+
label: Proposed Solution
26+
description: If you can suggest how the addition or change can be implemented, include a prototype/workaround/sketch/reference implementation.
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
id: other
32+
attributes:
33+
label: Other Information
34+
description: Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
35+
validations:
36+
required: false
37+
38+
- type: checkboxes
39+
id: implementation
40+
attributes:
41+
label: Implementation
42+
options:
43+
- label: I may be able to implement the feature.
44+
- label: It might incur a breaking change.
45+
46+
- type: input
47+
id: version
48+
attributes:
49+
label: Version
50+
description: Please provide the current WebUI version you are using.
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: environment
56+
attributes:
57+
label: Environment details (OS name and version, etc.)
58+
render: shell
59+
description: |
60+
To fill in this section, you can use on Unix-like systems:
61+
```sh
62+
uname -somr
63+
```
64+
On Windows you can use:
65+
```sh
66+
cmd /c wmic cpu get systemname,caption
67+
```
68+
validations:
69+
required: true

0 commit comments

Comments
 (0)