Updated BSOD/Security reporting instructions
Current language recommends users do not report BSODs/security issues. Updated language to permit users to do this, but provide instructions on how to safely share dumps/traces.
Rich Turner committed
Sep 11, 2017 at 13:21 UTC
2cd4039d9e38d7a7484a77a57f70cd2a2d1e55f8
1 file changed
+15
-7
CONTRIBUTING.md
+15
-7
@@ -2,21 +2,29 @@ Please provide as much information as possible when reporting a bug or filing an
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.
5
+## Important: Reporting BSODs and Security issues
6
+Please pay special attention if you want to report BSOD or security issues:
7
7
-A well written bug will follow the template:
8
+### BSODs
9
+When reporting BSODs, **DO NOT attach memory dumps or traces to Github issues**. Instead, send Windows crashes to secure@microsoft.com, referencing the GitHub bug number.
10
9
-### 1) Issue Title
11
+### Security Issues
12
+Special care should be taken when reporting security issues to avoid exposing sensitive information.
13
+
14
+Only send traces or logs when specifically asked to by a WSL team member, to secure@microsoft.com, referencing the GitHub bug number.
15
+
16
+> Note: Issues with security vulnerabilities may be edited to hide the vulnerability details.
17
+
18
+## Reporting issues in WSL
19
+A well written bug will follow the following template:
20
21
+### 1) Issue Title
22
A title succinctly describing the issue.
23
24
#### Example:
14
-
25
`Traceroute not working.`
26
17
-
27
### 2) Windows version / build number
19
-
28
Your Windows build number. This can be gathered from the CMD prompt using the `ver` command.
29
30
```
@@ -60,7 +68,7 @@ Run the failing command under [strace](http://manpages.ubuntu.com/manpages/wily/
68
$ strace -ff <command>
69
```
70
63
-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.
71
+> Note: `strace` can produce lengthy output. If the generated trace is more than about 20 lines please paste this into a [Gist](https://gist.github.com/) or another paste service and link in the bug.
72
73
#### Example:
74