Skip to content

Commit 5a31a47

Browse files
authored
Update the issue template to be more configurable (#1307)
1 parent a047a07 commit 5a31a47

File tree

4 files changed

+79
-9
lines changed

4 files changed

+79
-9
lines changed

.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/Bug_Report.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
1+
---
2+
name: "Bug report :bug:"
3+
about: Report errors or unexpected behaviors
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
110
<!--
2-
Before submitting your bug report, please check for duplicates, and +1 the duplicate if you find one, adding additional details if you have any to add.
311
4-
There are a few common issues that are commonly reported.
12+
Before submitting your bug report ...
13+
- Please make sure you are able to reproduce the issue with the latest version of PSReadLine.
14+
- Please check for duplicates. +1 the duplicate if you find one and add additional details if you have any.
15+
16+
The maintainer may close your issue without further explanation or engagement if:
17+
- You delete this entire template and go your own path;
18+
- You file an issue that has many duplicates;
19+
- You file an issue completely blank in the body.
520
6-
If there is an exception copying to/from the clipboard, it's probably the same as https://github.com/PowerShell/PSReadLine/issues/265
7-
If there is an exception shortly after resizing the console, it's probably the same as https://github.com/PowerShell/PSReadLine/issues/292
821
-->
922

10-
Environment data
11-
----------------
23+
## Environment
24+
25+
```none
26+
[run the script below and paste the output here]
27+
```
1228

1329
<!--
1430
1531
The following script will generate the environment data that helps triage and investigate the issue.
16-
Please run the script in the PowerShell session where you ran into the issue and provide the output here.
32+
Please run the script in the PowerShell session where you ran into the issue and provide the output above.
1733
1834
& {
1935
$hostName = $Host.Name
@@ -49,5 +65,18 @@ Please run the script in the PowerShell session where you ran into the issue and
4965
5066
-->
5167

52-
Steps to reproduce or exception report
53-
--------------------------------------
68+
## Exception report
69+
70+
<!-- Copy and paste the keys and the exception stack trace printed by PSReadLine, if there is any -->
71+
72+
## Steps to reproduce
73+
74+
<!-- A description of how to trigger this bug. -->
75+
76+
## Expected behavior
77+
78+
<!-- A description of what you're expecting, possibly containing screenshots or reference material. -->
79+
80+
## Actual behavior
81+
82+
<!-- What's actually happening? -->
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: "Documentation Issue :books:"
3+
about: Report issues in our documentation
4+
title: ''
5+
labels: Issue-Docs
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Briefly describe which document needs to be corrected and why. -->
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "Feature Request/Idea :rocket:"
3+
about: Suggest a new feature or improvement (this does not mean you have to implement it)
4+
title: ''
5+
labels: Issue-Enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
The maintainer may close your issue without further explanation or engagement if:
13+
- You delete this entire template and go your own path;
14+
- You file an issue that has many duplicates;
15+
- You file an issue completely blank in the body.
16+
17+
-->
18+
19+
## Description of the new feature/enhancement
20+
21+
<!--
22+
A clear and concise description of what the problem is that the new feature would solve.
23+
Describe why and how a user would use this new functionality (if applicable).
24+
-->
25+
26+
## Proposed technical implementation details (optional)
27+
28+
<!--
29+
A clear and concise description of what you want to happen.
30+
-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)