Skip to content

Commit 290c358

Browse files
authored
Update the issue templates to use form templates (#2898)
1 parent 0ae04cd commit 290c358

File tree

6 files changed

+139
-41
lines changed

6 files changed

+139
-41
lines changed
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: Bug report 🐛
2+
description: Report errors or unexpected behavior 🤔
3+
labels: Needs-Triage
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
options:
9+
- label: Write a descriptive title.
10+
required: true
11+
- label: Make sure you are able to repro it on the [latest released version](https://www.powershellgallery.com/packages/PSReadLine)
12+
required: true
13+
- label: Search the existing issues, especially the pinned issues.
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Exception report
18+
description: |
19+
Copy and paste the **COMPLETE** exception report message generated by PSReadLine.
20+
If no exception report was involved, simply put "N/A" below.
21+
render: console
22+
placeholder: Oops, something went wrong ...
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Screenshot
28+
description: |
29+
In case of an exception report, please scroll up your terminal window and take a screenshot of the terminal state right before the exception happened.
30+
Please keep your terminal window size unchanged when taking screenshot. The screenshot will be very helpful for us to triage the issue.
31+
If no exception was involved, please upload images or animations that you think may be helpful, or put "N/A" below.
32+
- type: textarea
33+
attributes:
34+
label: Environment data
35+
description: |
36+
The following script will generate the environment data that helps triage and investigate the issue.
37+
Please run the script in the PowerShell session where you ran into the issue, and paste the verbatim output below.
38+
```powershell
39+
& {
40+
$hostName = $Host.Name
41+
if ($hostName -eq "ConsoleHost" -and (Get-Command Get-CimInstance -ErrorAction SilentlyContinue)) {
42+
$id = $PID; $inWindowsTerminal = $false
43+
while ($true) {
44+
$p = Get-CimInstance -ClassName Win32_Process -Filter "ProcessId Like $id"
45+
if (!$p -or !$p.Name) { break }
46+
if ($p.Name -eq "WindowsTerminal.exe") { $inWindowsTerminal = $true; break }
47+
$id = $p.ParentProcessId
48+
}
49+
if ($inWindowsTerminal) { $hostName += " (Windows Terminal)" }
50+
}
51+
52+
$m = Get-Module PSReadline
53+
$v = $m.Version; $pre = $m.PrivateData.PSData.Prerelease
54+
if ($pre) { $v = "$v-$pre" }
55+
$os = if ($IsLinux -or $IsMacOS) { uname -a } else { (dir $env:SystemRoot\System32\cmd.exe).VersionInfo.FileVersion }
56+
57+
Write-Host ''
58+
Write-Host "PS Version: $($PSVersionTable.PSVersion)"
59+
Write-Host "PS HostName: $hostName"
60+
Write-Host "PSReadLine Version: $v"
61+
Write-Host "PSReadLine EditMode: $((Get-PSReadLineOption).EditMode)"
62+
Write-Host "OS: $os"
63+
Write-Host "BufferWidth: $([console]::BufferWidth)"
64+
Write-Host "BufferHeight: $([console]::BufferHeight)"
65+
Write-Host ''
66+
}
67+
```
68+
render: console
69+
placeholder: |
70+
PS Version: ...
71+
PS HostName: ...
72+
PSReadLine Version: ...
73+
PSReadLine EditMode: ...
74+
OS: ...
75+
BufferWidth: ...
76+
BufferHeight: ...
77+
validations:
78+
required: true
79+
- type: textarea
80+
attributes:
81+
label: Steps to reproduce
82+
description: |
83+
List of steps or sample code to reproduce the issue.
84+
placeholder: |
85+
A description of how to trigger the issue.
86+
validations:
87+
required: true
88+
- type: textarea
89+
attributes:
90+
label: Expected behavior
91+
placeholder: No exception ...
92+
validations:
93+
required: true
94+
- type: textarea
95+
attributes:
96+
label: Actual behavior
97+
placeholder: The above exception happens ...
98+
validations:
99+
required: true

.github/ISSUE_TEMPLATE/Documentation_Issue.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Documentation Issue 📚
2+
description: Report issues in our documentation.
3+
labels: Issue-Docs
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
options:
9+
- label: Write a descriptive title.
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Issue summary
14+
description: Briefly describe which document needs to be corrected and why.
15+
validations:
16+
required: true

.github/ISSUE_TEMPLATE/Feature_Request.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Feature Request or Idea 🚀
2+
description: Suggest a new feature or improvement.
3+
labels: Issue-Enhancement
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
options:
9+
- label: Write a descriptive title.
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Description of the new feature/enhancement
14+
description: |
15+
A clear and concise description of what the problem is that the new feature would solve.
16+
Describe why and how a user would use this new functionality (if applicable).
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Proposed technical implementation details (optional)
22+
description: |
23+
A clear and concise description of how you want it to happen.

PSReadLine/PSReadLineResources.resx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@
400400
<value>
401401
Oops, something went wrong.
402402
Please report this bug with ALL the details below, including both the 'Environment' and 'Exception' sections.
403-
Please report on GitHub: https://github.com/PowerShell/PSReadLine/issues/new?template=Bug_Report.md
403+
Please report on GitHub: https://github.com/PowerShell/PSReadLine/issues/new?template=Bug_Report.yaml
404404
Thank you!
405405
</value>
406406
</data>

0 commit comments

Comments
 (0)