Added new bug template (#5320)
* Added new bug template * Updated wording and removed markdown formatting in bug_report.md
Craig Loewen committed
Jun 3, 2020 at 10:21 UTC
bf8c84651cc1cfefbc65228fd8a50aab506b93de
1 file changed
+49
-8
.github/ISSUE_TEMPLATE/bug_report.md
+49
-8
@@ -6,19 +6,60 @@ labels: ''
6
assignees: ''
7
8
---
9
+<!--
10
+🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
11
10
-Please use the following bug reporting template to help produce issues which are actionable and reproducible, including **all** command-line steps necessary to induce the failure condition. See [our contributing instructions](https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md) for more information. If this is a console issue (a problem with layout, rendering, colors, etc.), please post to the [terminal tracker](https://github.com/microsoft/terminal/issues). For documentation improvements, please post to the [documentation tracker](https://github.com/MicrosoftDocs/WSL/issues).
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
12
-**Important: Do not open GitHub issues for Windows crashes (BSODs) or security issues.** Please direct all Windows crashes and security issues to secure@microsoft.com. Ideally, please [configure your machine to capture minidumps](https://support.microsoft.com/en-us/help/315263/how-to-read-the-small-memory-dump-file-that-is-created-by-windows-if-a), repro the issue, and send the minidump from "C:\Windows\minidump\".
13
-<br/><br/>
19
+All good? Then proceed!
20
+-->
21
15
-Please fill out **all** the fields! Issues with missing or incomplete issue templates will be closed.
22
+<!--
23
+This bug tracker is monitored by Windows Subsystem for Linux development team and other technical folks.
24
17
-* Your Windows build number (run `ver` at a Windows Command Prompt), your distribution (f.e. on Debian/Ubuntu run `lsb_release -r`), and whether the issue manifests on WSL 2 and/or WSL 1 (`cat /proc/version`):
25
+Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to Github issues.
26
+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\".
27
+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
28
19
-* 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:
29
+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
30
+For documentation improvements, please post to the documentation tracker: https://github.com/MicrosoftDocs/WSL/issues
31
+For any other questions on contributing please see our contribution guidelines: https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md
32
+
33
+Please fill out the items below.
34
+-->
35
+
36
+# Environment
37
+
38
+```none
39
+Windows build number: [run `[Environment]::OSVersion` for powershell, or `ver` for cmd]
40
+Your Distribution version: [On Debian or Ubuntu run `lsb_release -r` in WSL]
41
+Whether the issue is on WSL 2 and/or WSL 1: [run `cat /proc/version` in WSL]
42
+```
43
+
44
+# Steps to reproduce
45
+
46
+<!-- 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. -->
47
+
48
+<!--
49
+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.
50
+More info on `strace` can be found here: https://www.man7.org/linux/man-pages/man1/strace.1.html
51
+You can use Github gists to share the output: https://gist.github.com/
52
+
53
+Additionally, For WSL launch issues, please collect detailed logs, instructions here: https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md#8-detailed-logs
54
+-->
55
+
56
+# Expected behavior
57
+
58
+<!-- A description of what you're expecting, possibly containing screenshots or reference material. -->
59
+
60
+# Actual behavior
61
+
62
+<!-- What's actually happening? -->
63
21
-* What's wrong / what should be happening instead:
64
23
-* An [`strace(1)`](https://www.man7.org/linux/man-pages/man1/strace.1.html) 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](https://gist.github.com/)). For WSL launch issues, please [collect detailed logs](https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md#8-detailed-logs):
65