Tweak the issue template. Drop some questions that seldom generate useful information; re-order remaining questions to try to guide users into providing the most-useful details. Elaborate on how to gather requested information.
Adam Seering committed
Apr 15, 2017 at 00:22 UTC
431a27a1f917b0c7c792518ef3bdb53821adab81
2 files changed
+18
-26
CONTRIBUTING.md
+12
-18
@@ -1,5 +1,7 @@
1
Please provide as much information as possible when reporting a bug or filing an issue on the Windows Subsystem for Linux.
2
3
+This Github issues page is a bugtracker. It's intended for technical discussion and for debugging specific issues. If you have a feature request, you should instead post it to the [UserVoice](https://wpdev.uservoice.com/forums/266908). The UserVoice is better for tracking feature requests; it has a voting mechanism so the WSL team can put a higher priority behind issues that affect more people.
4
+
5
Do not open Github issues for Windows crashes (BSODs) or security issues. Please direct all Windows crashes and security issues to secure@microsoft.com. Issues with security vulnerabilities may be edited to hide the vulnerability details.
6
7
A well written bug will follow the template:
@@ -13,15 +15,7 @@ A title succinctly describing the issue.
15
`Traceroute not working.`
16
17
16
-### 2) Brief description
17
-
18
-A brief description of what you are attempting to run.
19
-
20
-####Example:
21
-
22
-`IP_MTU_DISCOVER error when running traceroute.`
23
-
24
-### 3) Windows version / build number
18
+### 2) Windows version / build number
19
20
Your Windows build number. This can be gathered from the CMD prompt using the `ver` command.
21
@@ -30,13 +24,13 @@ C:\>ver
24
Microsoft Windows [Version 10.0.14385]
25
```
26
33
-Note: The Windows Insider builds contain many updates and fixes. If you are running on the Anniversary Update (10.0.14393) please check to see if your issue has been resolved in a later build.
27
+Note: The Windows Insider builds contain many updates and fixes. If you are running on the Creators Update (10.0.15063) please check to see if your issue has been resolved in a later build. If you are running on the Anniversary Update (10.0.14393), please try updating to the Creators Update.
28
29
#### Example:
30
37
-`Microsoft Windows [Version 10.0.14385]`
31
+`Microsoft Windows [Version 10.0.16170]`
32
39
-### 4) Steps required to reproduce
33
+### 3) Steps required to reproduce
34
35
Should include all packages and environmental variables as well as other required configuration.
36
@@ -45,7 +39,7 @@ Should include all packages and environmental variables as well as other require
39
`$ sudo apt-get install traceroute`
40
`$ traceroute www.microsoft.com`
41
48
-### 5) Copy of the terminal output
42
+### 4) Copy of the terminal output
43
44
#### Example:
45
@@ -55,16 +49,16 @@ traceroute to www.microsoft.com (23.75.239.28), 30 hops max, 60 byte packets
49
setsockopt IP_MTU_DISCOVER: Invalid argument
50
```
51
58
-### 6) Expected Behavior
52
+### 5) Expected Behavior
53
54
What was the expected result of the command? Include examples / documentation if possible.
55
62
-### 7) Strace of the failing command
56
+### 6) Strace of the failing command
57
58
Run the failing command under [strace] (http://manpages.ubuntu.com/manpages/wily/man1/strace.1.html). Normal command structure is:
59
60
```
67
-$ strace <command>
61
+$ strace -ff <command>
62
```
63
64
Strace can produce a very long output. If this is more than about 20 lines please paste this into [Gist](https://gist.github.com/) or another paste service and link in the bug.
@@ -83,7 +77,7 @@ access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory)
77
...
78
```
79
86
-### 8) Additional information
80
+### 7) Additional information
81
82
Some bugs require additional information such as scripts to reproduce. Please add to this section.
83
@@ -99,7 +93,7 @@ Additional strace logs if the error occurs within a fork. The following command
93
$ strace -ff -o <outputfile> <command>
94
```
95
102
-### 9) Detailed Logs
96
+### 8) Detailed Logs
97
Some bugs will require more detailed logs to help determine the cause. There is a CMD command to start detailed logging and another to stop. The logs are generated locally into the working directory.
98
99
#### Start
ISSUE_TEMPLATE.md
+6
-8
@@ -1,17 +1,15 @@
1
-Please use the following bug reporting template to help produce actionable and reproducible issues. Please try to ensure that the reproduction is minimal so that the team can go through more bugs!
1
+This bug-tracker is monitored by developers and other technical types. We like detail! So please use this form and tell us, concisely but precisely, what's up. Please fill out ALL THE FIELDS!
2
3
-* A brief description
3
+If you have a feature request, please post to [the UserVoice](https://wpdev.uservoice.com/forums/266908). If you're reporting a BSOD, don't post here! Instead, e-mail "secure@microsoft.com", and if possible attach the minidump from "C:\Windows\minidump\".
4
5
-* Expected results
5
7
-* Actual results (with terminal output if applicable)
6
+* Your Windows build number: (Type `ver` at a Windows Command Prompt)
7
9
-* Your Windows build number
8
+* What you're doing and what's happening: (Copy&paste specific commands and their output, or include screen shots)
9
11
-* Steps / All commands required to reproduce the error from a brand new installation
10
+* What's wrong / what should be happening instead:
11
13
-* Strace of the failing command
12
+* Strace of the failing command, if applicable: (If `<cmd>` is failing, then run `strace -o strace.txt -ff <cmd>`, and post the strace.txt output here)
13
15
-* Required packages and commands to install
14
15
See [our contributing instructions](/CONTRIBUTING.md) for assistance.