Updating WSL bug template to use GitHub Issue Form (#6786)
* Adding issue form for bug reports
adrastogi committed
Apr 9, 2021 at 10:46 UTC
7e6f56c63350277e5d2caf71038db315fcded670
2 files changed
+87
-69
.github/ISSUE_TEMPLATE/Bug_Report.yaml
new
+87
@@ -0,0 +1,87 @@
1
+---
2
+name: "Bug Report"
3
+description: Report a bug on Windows Subsystem for Linux
4
+title: ''
5
+labels: ''
6
+assignees: ''
7
+issue_body: true
8
+body:
9
+- type: markdown
10
+ attributes:
11
+ value: |
12
+ Please [search for existing issues](https://github.com/microsoft/WSL/issues) before creating a new one.
13
+ If you'd like to create a new bug report, please [read the guidance here](https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md) before getting started. This will save you time.
14
+
15
+- type: input
16
+ attributes:
17
+ label: Windows Build Number
18
+ description: |
19
+ Please run `cmd.exe /c ver` to get the build of Windows you are on.
20
+ placeholder: "Microsoft Windows [Version 10.0.19042.867]"
21
+ validations:
22
+ required: true
23
+
24
+- type: input
25
+ attributes:
26
+ label: WSL Version
27
+ description: |
28
+ Tell us whether the issue is on WSL 2 and/or WSL 1. You can tell your WSL version by running `wsl -l -v`.
29
+ placeholder: "WSL 2"
30
+ validations:
31
+ required: true
32
+
33
+- type: input
34
+ attributes:
35
+ label: Distro Version
36
+ description: |
37
+ Please tell us what distro you are using (if applicable).
38
+ You can get additional information about the version where possible, e.g. on Debian / Ubuntu, run `lsb_release -r`
39
+ placeholder: "Ubuntu 16.04"
40
+ validations:
41
+ required: false
42
+
43
+- type: textarea
44
+ attributes:
45
+ label: Other Software
46
+ description: If you're reporting a bug involving WSL's interaction with other applications, please tell us. What applications? What versions?
47
+ placeholder: |
48
+ Docker Desktop (Windows), version 3.2.2
49
+ traceroute, Version: 1:2.0.21-1
50
+ Visual Studio Code 1.54.3 with Remote-WSL Extension 0.54.6
51
+ MyCustomApplication
52
+ validations:
53
+ required: false
54
+
55
+- type: textarea
56
+ attributes:
57
+ label: Repro Steps
58
+ description: Please list out the steps to reproduce your bug.
59
+ placeholder: Your steps go here. Include relevant environmental variables or any other configuration.
60
+ validations:
61
+ required: true
62
+
63
+- type: textarea
64
+ attributes:
65
+ label: Expected Behavior
66
+ description: What were you expecting to see? Include any relevant examples or documentation links.
67
+ placeholder: If you want to include screenshots, paste them into the markdown editor below the form or follow up with a separate comment.
68
+ validations:
69
+ required: true
70
+
71
+- type: textarea
72
+ attributes:
73
+ label: Actual Behavior
74
+ description: What happened instead?
75
+ placeholder: Include the terminal output, straces of the failing command, etc. as necessary.
76
+ validations:
77
+ required: true
78
+
79
+- type: textarea
80
+ attributes:
81
+ label: Diagnostic Logs
82
+ description: |
83
+ Please provide additional diagnostics if needed.
84
+ See the [guidance](https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md) for info on how to gather Feedback Hub logs, networking logs, and more.
85
+ placeholder: Your links to logs or other information go here.
86
+ validations:
87
+ required: false
.github/ISSUE_TEMPLATE/bug_report.md
deleted
-69
@@ -1,69 +0,0 @@
1
----
2
-name: Bug report
3
-about: Report a bug on Windows Subsystem for Linux
4
-title: ''
5
-labels: ''
6
-assignees: ''
7
-
8
----
9
-<!--
10
-🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
11
-
12
-I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING:
13
-1. If I delete this entire template and go my own path, the core team may close my issue without further explanation or engagement.
14
-2. If I list multiple bugs/concerns in this one issue, the core team may close my issue without further explanation or engagement.
15
-3. If I write an issue that has many duplicates, the core team may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number).
16
-4. If I leave the title incomplete when filing the issue, the core team may close my issue without further explanation or engagement.
17
-5. If I file something completely blank in the body, the core team may close my issue without further explanation or engagement.
18
-6. If I file an issue without collecting logs, the WSL team may close my issue without further explanation or engagement.
19
-
20
-All good? Then proceed!
21
--->
22
-
23
-<!--
24
-This bug tracker is monitored by Windows Subsystem for Linux development team and other technical folks.
25
-
26
-Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to Github issues.
27
-Instead, send dumps/traces to secure@microsoft.com, referencing this GitHub issue. Ideally, please configure your machine to capture minidumps, repro the issue, and send the minidump from "C:\Windows\minidump\".
28
-You can find instructions to do that here: https://support.microsoft.com/en-us/help/315263/how-to-read-the-small-memory-dump-file-that-is-created-by-windows-if-a
29
-
30
-If this is a console issue (a problem with layout, rendering, colors, etc.), please post the issue to the Terminal tracker: https://github.com/microsoft/terminal/issues
31
-For documentation improvements, please post to the documentation tracker: https://github.com/MicrosoftDocs/WSL/issues
32
-For any other questions on contributing please see our contribution guidelines: https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md
33
-
34
-Please fill out the items below.
35
--->
36
-
37
-# Environment
38
-
39
-```none
40
-Windows build number: [run `cmd.exe /c ver`]
41
-Your Distribution version: [On Debian or Ubuntu run `lsb_release -r` in WSL]
42
-Whether the issue is on WSL 2 and/or WSL 1: [run `cat /proc/version` in WSL]
43
-```
44
-
45
-# Steps to reproduce
46
-
47
-<!-- What you're doing and what's happening. Copy&paste the full set of specific command-line steps necessary to reproduce the behavior, and their output. Include screenshots if that helps demonstrate the problem. -->
48
-
49
-<!--
50
-If you'd like to provide logs you can provide an `strace(1)` log of the failing command (if `some_command` is failing, then run `strace -o some_command.strace -f some_command some_args`, and link the contents of `some_command.strace` in a gist.
51
-More info on `strace` can be found here: https://www.man7.org/linux/man-pages/man1/strace.1.html
52
-You can use Github gists to share the output: https://gist.github.com/
53
--->
54
-
55
-<!--
56
-Collect WSL logs by following these instructions: https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md#8-detailed-logs
57
--->
58
-**WSL logs**:
59
-
60
-# Expected behavior
61
-
62
-<!-- A description of what you're expecting, possibly containing screenshots or reference material. -->
63
-
64
-# Actual behavior
65
-
66
-<!-- What's actually happening? -->
67
-
68
-
69
-