Skip to content

Commit 62b840c

Browse files
committed
Update template
1 parent c606a51 commit 62b840c

File tree

3 files changed

+90
-38
lines changed

3 files changed

+90
-38
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 60 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,82 @@ body:
99
id: "describe"
1010
attributes:
1111
label: "Describe"
12-
description: "What the bug is?"
12+
description: |-
13+
What the bug is? Add images and/or videos to help for explain this bug if necessary.
14+
15+
> **ℹ️ Notice:**
16+
>
17+
> - Should not blur anything in the images and/or videos, except personal secrets.
18+
> - For upload images and/or videos, please ensure to wait for the upload process to complete.
19+
> - For external images and/or videos, please ensure whether we can view these.
20+
validations:
21+
required: true
22+
- type: "textarea"
23+
id: "reproduce"
24+
attributes:
25+
label: "To Reproduce"
26+
description: |-
27+
Is this bug reproducible? If reproducible, please show the required steps by list, images, and/or videos!
28+
29+
> **ℹ️ Notice:**
30+
>
31+
> - Should not blur anything in the images and/or videos, except personal secrets.
32+
> - For upload images and/or videos, please ensure to wait for the upload process to complete.
33+
> - For external images and/or videos, please ensure whether we can view these.
34+
placeholder: |-
35+
1. Go to XXXX.
36+
2. Click on XXXX.
37+
3. Scroll to XXXX.
38+
4. Encounter this error.
1339
validations:
1440
required: false
15-
- type: "dropdown"
16-
id: "version"
41+
- type: "textarea"
42+
id: "expected-behaviour"
1743
attributes:
18-
label: "Version"
19-
description: "What versions are affected? Versions must be listed as supported in the Security Policy (file: `SECURITY.md`)."
20-
multiple: true
21-
options:
22-
- "v1.7.2"
23-
- "v1.7.1"
24-
- "v1.7.0"
25-
- "v1.6.0"
26-
- "v1.5.0"
27-
- "v1.4.1"
28-
- "v1.4.0"
44+
label: "Expected Behaviour"
45+
description: |-
46+
What things should expected to happen?
2947
validations:
3048
required: false
3149
- type: "textarea"
32-
id: "reproduce"
50+
id: "version"
3351
attributes:
34-
label: "To Reproduce"
35-
description: "If this bug can be reproduce, please list the steps!"
52+
label: "Version"
53+
description: |-
54+
Which versions are affected by this bug?
55+
56+
> **ℹ️ Notice:**
57+
>
58+
> - Accept versions range.
59+
> - For multiple versions and/or versions ranges, list with Markdown unordered list syntax.
60+
> - Versions must be listed as supported in the Security Policy (file: `SECURITY.md`).
3661
validations:
3762
required: false
3863
- type: "textarea"
39-
id: "expected-behavior"
64+
id: "execution-environment"
4065
attributes:
41-
label: "Expected Behavior"
42-
description: "What things should expected to happen?"
66+
label: "Execution Environment"
67+
description: |-
68+
How is the execution environment?
69+
70+
- **Device Type:** `Computer` / `Phone` / `Server` / ...
71+
- **Architecture:** `X64` / `X86` / `ARM64` / `ARM32` / `RISC` / ...
72+
- **Platforms:** `Windows 11 22H2` / `Android 14` / `Alpine 3.18.0` / `NodeJS 20.6.0` / `Deno 1.36.0` / `Git 2.42.0` / `Python 3.11.0` / ...
73+
- **Is In Sub System:** `False` / `True`
74+
- **Variables:** `NO_COLOR=1` / ...
75+
76+
> **ℹ️ Notice:**
77+
>
78+
> - Accept multiple execution environments.
79+
> - All of the properties are optional.
80+
> - It is recommended to provide this information for reproducible steps.
4381
validations:
4482
required: false
4583
- type: "textarea"
4684
id: "additional-information"
4785
attributes:
4886
label: "Additional Information"
49-
description: "If there have information that related to this issue but not suitable to the other fields, please list those at here."
87+
description: |-
88+
If there have information that related to this bug but not suitable at other fields, please list those at here.
5089
validations:
5190
required: false

.github/ISSUE_TEMPLATE/documentation-issue.yml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,40 @@ labels:
66
- "Type/Documentation 📓"
77
body:
88
- type: "textarea"
9-
id: "describe"
9+
id: "page"
1010
attributes:
11-
label: "Describe"
12-
description: "What the issue is?"
11+
label: "Page"
12+
description: |-
13+
List of the related pages.
1314
validations:
14-
required: false
15+
required: true
1516
- type: "textarea"
16-
id: "page"
17+
id: "describe"
1718
attributes:
18-
label: "Page"
19-
description: "List of the related pages."
19+
label: "Describe"
20+
description: |-
21+
What the issue is? Add images and/or videos to help for explain this bug if necessary.
22+
23+
> **ℹ️ Notice:**
24+
>
25+
> - Should not blur anything in the images and/or videos, except personal secrets.
26+
> - For upload images and/or videos, please ensure to wait for the upload process to complete.
27+
> - For external images and/or videos, please ensure whether we can view these.
2028
validations:
21-
required: false
29+
required: true
2230
- type: "textarea"
2331
id: "expected-content"
2432
attributes:
2533
label: "Expected Content"
26-
description: "What contents should expected?"
34+
description: |-
35+
What contents should expected?
2736
validations:
2837
required: false
2938
- type: "textarea"
3039
id: "additional-information"
3140
attributes:
3241
label: "Additional Information"
33-
description: "If there have information that related to this issue but not suitable to the other fields, please list those at here."
42+
description: |-
43+
If there have information that related to this issue but not suitable at other fields, please list those at here.
3444
validations:
3545
required: false

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,23 @@ body:
99
id: "describe"
1010
attributes:
1111
label: "Describe"
12-
description: "What feature do you want?"
12+
description: |-
13+
What feature do you want? Is your feature request related to a problem?
1314
validations:
14-
required: false
15+
required: true
1516
- type: "textarea"
16-
id: "expected-behavior"
17+
id: "expected-behaviour"
1718
attributes:
18-
label: "Expected Behavior"
19-
description: "What things should expected to happen?"
19+
label: "Expected Behaviour"
20+
description: |-
21+
What things should expected to happen?
2022
validations:
21-
required: false
23+
required: true
2224
- type: "textarea"
2325
id: "additional-information"
2426
attributes:
2527
label: "Additional Information"
26-
description: "If there have information that related to this issue but not suitable to the other fields, please list those at here."
28+
description: |-
29+
If there have information that related to this issue but not suitable at other fields, please list those at here.
2730
validations:
2831
required: false

0 commit comments

Comments
 (0)