Skip to content

Commit 08b05f6

Browse files
authored
Update issue templates (#8482)
Our issue templates required users checking several "preflight checklist" checkboxes. Requiring these fields was an attempt to encourage users to follow these instructions before filing issues. However, they add unecessary clutter to the issues that are formed, and a lot of users either don't find what they're looking for or ignore the information anyway. Convering the information to Markdown instead of as inputs is more convenient for users and for us.
1 parent 5fcd0fb commit 08b05f6

2 files changed

Lines changed: 34 additions & 34 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,18 @@ name: Report a Bug
22
description: Something not working as expected? Create an issue to help us improve.
33
type: "Bug"
44
body:
5-
- type: checkboxes
6-
id: pre-flight
7-
attributes:
8-
label: Preflight Checklist
9-
description: "Before submitting a bug report, please make sure you've done the following:"
10-
options:
11-
- label: I have installed the [latest version of Storage Explorer](https://github.com/Microsoft/AzureStorageExplorer/releases/latest).
12-
required: true
13-
- label: I have checked existing resources, including the [troubleshooting guide](https://docs.microsoft.com/azure/storage/common/storage-explorer-troubleshooting) and the [release notes](https://github.com/microsoft/AzureStorageExplorer/releases).
14-
required: true
15-
- label: I have searched for [similar issues](https://github.com/Microsoft/AzureStorageExplorer/issues).
16-
required: true
17-
185
- type: markdown
196
attributes:
20-
value: ---
7+
value: |
8+
### Preflight Checklist
9+
10+
Before submitting a bug report, please make sure you've done the following:
11+
12+
- [ ] I have installed the [latest version of Storage Explorer](https://github.com/Microsoft/AzureStorageExplorer/releases/latest).
13+
- [ ] I have checked existing resources, including the [troubleshooting guide](https://docs.microsoft.com/azure/storage/common/storage-explorer-troubleshooting) and the [release notes](https://github.com/microsoft/AzureStorageExplorer/releases).
14+
- [ ] I have searched for [similar issues](https://github.com/Microsoft/AzureStorageExplorer/issues).
15+
16+
---
2117
2218
- type: input
2319
id: app-version
@@ -41,7 +37,6 @@ body:
4137
label: Architecture
4238
description: Open the About dialog in Storage Explorer to find this.
4339
options:
44-
- i86
4540
- x64
4641
- arm64
4742
validations:
@@ -69,13 +64,12 @@ body:
6964
- Linux (snap)
7065
validations:
7166
required: true
72-
67+
7368
- type: input
7469
id: os-version
7570
attributes:
7671
label: OS Version
77-
placeholder: Windows 10; macOS Big Sur; Ubuntu 20.04
78-
72+
placeholder: Windows 11; macOS Sequoia 15.3.1; Ubuntu 22.04
7973
- type: markdown
8074
attributes:
8175
value: ---
@@ -85,6 +79,8 @@ body:
8579
attributes:
8680
label: Bug Description
8781
description: Provide a clear, concise description of the bug.
82+
placeholder: |
83+
Describe the bug you're seeing.
8884
validations:
8985
required: true
9086

@@ -104,6 +100,8 @@ body:
104100
attributes:
105101
label: Actual Experience
106102
description: Provide a clear, concise description of what actually happens. If applicable, add screenshots to help explain what happened.
103+
placeholder: |
104+
What actually happens when I follow the steps to reproduce?
107105
validations:
108106
required: true
109107

@@ -112,9 +110,14 @@ body:
112110
attributes:
113111
label: Expected Experience
114112
description: Provide a clear, concise description of what you expected to happen. If applicable, add screenshots to help explain what you expected.
113+
placeholder: |
114+
What should happen when I follow the steps to reproduce?
115115
116116
- type: textarea
117117
id: context
118118
attributes:
119119
label: Additional Context
120120
description: Add any other details, such as error messages, unusual system configurations, network restrictions, etc.
121+
placeholder: |
122+
Error messages, proxy configurations, system permissions, etc.
123+

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
name: Request a Feature
22
description: Have an idea that would make Storage Explorer better? Let us know!
33
type: "Feature"
4-
labels:
5-
- ":bulb: feature request"
64
body:
7-
- type: checkboxes
8-
id: pre-flight
9-
attributes:
10-
label: Preflight Checklist
11-
description: "Before submitting a feature request, please make sure you've done the following:"
12-
options:
13-
- label: I have installed the [latest version of Storage Explorer](https://github.com/Microsoft/AzureStorageExplorer/releases/latest).
14-
required: true
15-
- label: I have checked existing resources, including the [troubleshooting guide](https://docs.microsoft.com/azure/storage/common/storage-explorer-troubleshooting) and the [release notes](https://github.com/microsoft/AzureStorageExplorer/releases).
16-
required: true
17-
- label: I have searched for [similar issues](https://github.com/Microsoft/AzureStorageExplorer/issues).
18-
required: true
19-
205
- type: markdown
216
attributes:
22-
value: ---
7+
value: |
8+
### Preflight Checklist
9+
10+
Before submitting a feature request, please make sure you've done the following:
11+
12+
- [ ] I have installed the [latest version of Storage Explorer](https://github.com/Microsoft/AzureStorageExplorer/releases/latest).
13+
- [ ] I have checked existing resources, including the [troubleshooting guide](https://docs.microsoft.com/azure/storage/common/storage-explorer-troubleshooting) and the [release notes](https://github.com/microsoft/AzureStorageExplorer/releases).
14+
- [ ] I have searched for [similar issues](https://github.com/Microsoft/AzureStorageExplorer/issues).
15+
16+
---
2317
2418
- type: input
2519
id: goal
@@ -58,3 +52,6 @@ body:
5852
attributes:
5953
label: Additional Context
6054
description: Add any other context or screenshots that can help us understand your feature request better.
55+
placeholder: |
56+
Often my work involves...
57+
I need this for...

0 commit comments

Comments
 (0)