Skip to content

Commit ea1a6e6

Browse files
deadlydogdeadlydog
committedMar 23, 2024
Update bug and feature request issue templates
·
v1.2.1v0.1.0
1 parent 4fc699d commit ea1a6e6

File tree

9 files changed

+324
-145
lines changed

9 files changed

+324
-145
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: 🐞 Bug report
2+
description: File a bug/issue
3+
title: "Bug: <title>"
4+
labels: ["bug"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Summary
16+
description: A concise description of the problem you're experiencing.
17+
placeholder: |
18+
When I do '...', I expect '...' to happen, but instead '...' happens.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Steps To Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Open PowerShell v7 prompt as admin...
27+
2. Navigate to the repo directory...
28+
3. Run the command '...'
29+
4. See error...
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: powershell-version
34+
attributes:
35+
label: PowerShell Version
36+
description: Paste verbatim output from `$PSVersionTable; $Host` below. **Please include `$Host`** so we know this version is from the Extension Terminal!
37+
render: console
38+
placeholder: |
39+
PS> $PSVersionTable; $Host
40+
41+
Name Value
42+
---- -----
43+
PSVersion 7.4.0
44+
PSEdition Core
45+
GitCommitId 7.4.0
46+
OS Microsoft Windows 10.0.22631
47+
Platform Win32NT
48+
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
49+
PSRemotingProtocolVersion 2.3
50+
SerializationVersion 1.1.0.1
51+
WSManStackVersion 3.0
52+
53+
Name : Visual Studio Code Host
54+
Version : 2023.11.0
55+
InstanceId : 803ce61b-6187-4574-9c1f-827ebb11b8b6
56+
UI : System.Management.Automation.Internal.Host.InternalHostUserInterface
57+
CurrentCulture : en-US
58+
CurrentUICulture : en-US
59+
PrivateData : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
60+
DebuggerEnabled : True
61+
IsRunspacePushed : False
62+
Runspace : System.Management.Automation.Runspaces.LocalRunspace
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: vscode-version
67+
attributes:
68+
label: Visual Studio Code Version
69+
description: Paste verbatim output from `code --version` below.
70+
render: console
71+
placeholder: |
72+
PS> code --version
73+
74+
1.57.1
75+
507ce72a4466fbb27b715c3722558bb15afa9f48
76+
arm64
77+
validations:
78+
required: true
79+
- type: textarea
80+
id: extension-version
81+
attributes:
82+
label: Extension Version
83+
description: Paste verbatim output from `code --list-extensions --show-versions | Select-String powershell` below.
84+
render: console
85+
placeholder: |
86+
PS> code --list-extensions --show-versions | Select-String powershell
87+
88+
ms-vscode.powershell@2021.8.0
89+
validations:
90+
required: true
91+
- type: textarea
92+
attributes:
93+
label: Visuals
94+
description: Add screenshots, gifs, or videos to help explain the problem.
95+
placeholder: |
96+
Here is a screenshot of the problem after I do '...':
97+
![Screenshot](https://example.com/screenshot.png)
98+
99+
Here is a screenshot of the expected behaviour using an older version:
100+
![Screenshot](https://example.com/screenshot-previous-version.png)
101+
validations:
102+
required: false
103+
- type: textarea
104+
attributes:
105+
label: Anything else?
106+
description: |
107+
Any other context or information about the problem or how to reproduce it.
108+
e.g. Logs files (with sensitive information removed), error messages, links, references, etc.
109+
110+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
111+
validations:
112+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: ✨ Feature request
2+
description: Suggest an idea for this project
3+
title: "Feature Request: <title>"
4+
labels: ["enhancement"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if a feature request already exists for what you are suggesting.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Problem to solve
16+
description: Is your feature request related to a problem? Please describe.
17+
placeholder: |
18+
Ex. I'm always frustrated when '...'.
19+
Ex. I want to be able to '...'.
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: Summary
25+
description: Describe the solution you'd like.
26+
placeholder: |
27+
A clear and concise description of what you want to happen.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Alternative solutions
33+
description: Describe any alternative solutions you've considered that may address the issue.
34+
validations:
35+
required: false
36+
- type: textarea
37+
attributes:
38+
label: Visuals
39+
description: If applicable, add screenshots, gifs, or videos to help explain the feature you are requesting.
40+
placeholder: |
41+
Here is a mockup of the feature I am suggesting:
42+
![Screenshot](https://example.com/screenshot.png)
43+
validations:
44+
required: false
45+
- type: textarea
46+
attributes:
47+
label: Anything else?
48+
description: Add any other context or information about the feature request here.
49+
validations:
50+
required: false

‎ReadMe.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ Things to still do:
117117
Perhaps link to [this tutorial](https://dev.to/olalekan_oladiran_d74b7a6/how-to-enable-continuous-integration-with-azure-pipelines-1doi)?
118118
- In the ReadMe setup instructions or above, have a sentence or two explaining the layout of the ReadMe, or maybe a table of contents
119119
- Add some badges as well to the ReadMe.
120-
- Look at improving GitHub issue and PR templates: https://raw.githubusercontent.com/PowerShell/vscode-powershell/main/.github/ISSUE_TEMPLATE/bug-report.yml
121120
- To prevent having to store CI/CD manual setup images in the repo, maybe have them as an external link to a GitHub branch.
122121
- Also create videos showing how to do the setup.
123122
- Maybe show instructions for setting up GitHub / Azure DevOps CI/CD during the initialization script. Or mention to follow the ReadMe instructions.

‎src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: 🐞 Bug report
2+
description: File a bug/issue
3+
title: "Bug: <title>"
4+
labels: ["bug"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Summary
16+
description: A concise description of the problem you're experiencing.
17+
placeholder: |
18+
When I do '...', I expect '...' to happen, but instead '...' happens.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Steps To Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Open PowerShell v7 prompt as admin...
27+
2. Navigate to the repo directory...
28+
3. Run the command '...'
29+
4. See error...
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: powershell-version
34+
attributes:
35+
label: PowerShell Version
36+
description: Paste verbatim output from `$PSVersionTable; $Host` below. **Please include `$Host`** so we know this version is from the Extension Terminal!
37+
render: console
38+
placeholder: |
39+
PS> $PSVersionTable; $Host
40+
41+
Name Value
42+
---- -----
43+
PSVersion 7.4.0
44+
PSEdition Core
45+
GitCommitId 7.4.0
46+
OS Microsoft Windows 10.0.22631
47+
Platform Win32NT
48+
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
49+
PSRemotingProtocolVersion 2.3
50+
SerializationVersion 1.1.0.1
51+
WSManStackVersion 3.0
52+
53+
Name : Visual Studio Code Host
54+
Version : 2023.11.0
55+
InstanceId : 803ce61b-6187-4574-9c1f-827ebb11b8b6
56+
UI : System.Management.Automation.Internal.Host.InternalHostUserInterface
57+
CurrentCulture : en-US
58+
CurrentUICulture : en-US
59+
PrivateData : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
60+
DebuggerEnabled : True
61+
IsRunspacePushed : False
62+
Runspace : System.Management.Automation.Runspaces.LocalRunspace
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: vscode-version
67+
attributes:
68+
label: Visual Studio Code Version
69+
description: Paste verbatim output from `code --version` below.
70+
render: console
71+
placeholder: |
72+
PS> code --version
73+
74+
1.57.1
75+
507ce72a4466fbb27b715c3722558bb15afa9f48
76+
arm64
77+
validations:
78+
required: true
79+
- type: textarea
80+
id: extension-version
81+
attributes:
82+
label: Extension Version
83+
description: Paste verbatim output from `code --list-extensions --show-versions | Select-String powershell` below.
84+
render: console
85+
placeholder: |
86+
PS> code --list-extensions --show-versions | Select-String powershell
87+
88+
ms-vscode.powershell@2021.8.0
89+
validations:
90+
required: true
91+
- type: textarea
92+
attributes:
93+
label: Visuals
94+
description: Add screenshots, gifs, or videos to help explain the problem.
95+
placeholder: |
96+
Here is a screenshot of the problem after I do '...':
97+
![Screenshot](https://example.com/screenshot.png)
98+
99+
Here is a screenshot of the expected behaviour using an older version:
100+
![Screenshot](https://example.com/screenshot-previous-version.png)
101+
validations:
102+
required: false
103+
- type: textarea
104+
attributes:
105+
label: Anything else?
106+
description: |
107+
Any other context or information about the problem or how to reproduce it.
108+
e.g. Logs files (with sensitive information removed), error messages, links, references, etc.
109+
110+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
111+
validations:
112+
required: false

‎src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: ✨ Feature request
2+
description: Suggest an idea for this project
3+
title: "Feature Request: <title>"
4+
labels: ["enhancement"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if a feature request already exists for what you are suggesting.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Problem to solve
16+
description: Is your feature request related to a problem? Please describe.
17+
placeholder: |
18+
Ex. I'm always frustrated when '...'.
19+
Ex. I want to be able to '...'.
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: Summary
25+
description: Describe the solution you'd like.
26+
placeholder: |
27+
A clear and concise description of what you want to happen.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Alternative solutions
33+
description: Describe any alternative solutions you've considered that may address the issue.
34+
validations:
35+
required: false
36+
- type: textarea
37+
attributes:
38+
label: Visuals
39+
description: If applicable, add screenshots, gifs, or videos to help explain the feature you are requesting.
40+
placeholder: |
41+
Here is a mockup of the feature I am suggesting:
42+
![Screenshot](https://example.com/screenshot.png)
43+
validations:
44+
required: false
45+
- type: textarea
46+
attributes:
47+
label: Anything else?
48+
description: Add any other context or information about the feature request here.
49+
validations:
50+
required: false

0 commit comments

Comments
 (0)
Please sign in to comment.