Update CONTRIBUTING.md
Jack Hammons committed
Jul 11, 2016 at 16:22 UTC
1d2fdd023ee3896b210a339e8c32f5f513f1f4db
1 file changed
+53
-36
CONTRIBUTING.md
renamed
+53
-36
@@ -1,12 +1,25 @@
1
Please provide as much information as possible when reporting a bug or filing an issue on the Windows Subsystem for Linux.
2
A well written bug will follow the template:
3
4
-1) Issue Title
4
+###1) Issue Title
5
6
-2) Brief description
7
-Briefly describe what you are attemping to run.
6
+A title succinctly describing the issue.
7
+
8
+####Example
9
+
10
+`Traceroute not working.`
11
+
12
+
13
+###2) Brief description
14
+
15
+A brief description of what you are attemping to run.
16
+
17
+####Example
18
+
19
+`IP_MTU_DISCOVER error when running traceroute.`
20
+
21
+###3) Windows version / build number
22
9
-3) Windows version / build number
23
Your Windows build number. This can be gathered from the CMD prompt using the `ver` command.
24
25
```
@@ -14,53 +27,41 @@ C:\>ver
27
Microsoft Windows [Version 10.0.14385]
28
```
29
17
-4) Commands required to reproduce the error
18
-Should include all packages required to install and configuration required.
19
-
20
-5) Copy of the terminal output
21
-
22
-6) Strace of the failing command
23
-Run the failing command under [strace] (http://manpages.ubuntu.com/manpages/wily/man1/strace.1.html). Normal command structure is:
30
+####Example
31
25
-```
26
-$ strace <command>
27
-```
32
+`Microsoft Windows [Version 10.0.14385]`
33
29
-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.
34
+###4) All commands required to reproduce the error
35
31
-7) Additional information
32
-Some bugs require additional information such as scripts to reproduce. Please add to this section.
36
+Should include all packages and environmental variables as well as other required configuration.
37
34
-If there are files required, email the files to InsiderSupport@microsoft.com with:
35
-Subject: Forward to WSL Team - RE: github issue <issue #>
36
-Body: "Please forward to WSL Team" and include your attachment.
38
+####Example
39
38
-Common files are:
39
-Memory dumps found under C:\Windows\MEMORY.DMP
40
-Additional strace logs if the error occurs within a fork. The following command generates an output file for every fork created:
40
+`$ sudo apt-get install traceroute`
41
+`$ traceroute www.microsoft.com`
42
42
-```
43
-$ strace -ff -o <outputfile> <command>
44
-```
43
+###5) Copy of the terminal output
44
45
+####Example
46
47
+```
48
+russ@RUSSALEX-BOOK:/mnt/c$ traceroute www.microsoft.com
49
+traceroute to www.microsoft.com (23.75.239.28), 30 hops max, 60 byte packets
50
+setsockopt IP_MTU_DISCOVER: Invalid argument
51
+```
52
48
-1)`Traceroute not working.`
49
-2)`IP_MTU_DISCOVER error when running traceroute.`
53
+###6) Strace of the failing command
54
51
-3)`Microsoft Windows [Version 10.0.14385]`
55
+Run the failing command under [strace] (http://manpages.ubuntu.com/manpages/wily/man1/strace.1.html). Normal command structure is:
56
53
-4)`$ sudo apt-get install traceroute`
54
-`$ traceroute www.microsoft.com`
57
+```
58
+$ strace <command>
59
+```
60
56
-5) Copy of the terminal output
61
+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.
62
58
-```russ@RUSSALEX-BOOK:/mnt/c$ traceroute www.microsoft.com
59
-traceroute to www.microsoft.com (23.75.239.28), 30 hops max, 60 byte packets
60
-setsockopt IP_MTU_DISCOVER: Invalid argument```
63
+####Example
64
62
-6)
65
```
66
russ@RUSSALEX-BOOK:/mnt/c$ strace traceroute www.microsoft.com
67
execve("/usr/bin/traceroute", ["traceroute", "www.microsoft.com"], [/* 22 vars */]) = 0
@@ -72,3 +73,18 @@ access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory)
73
...
74
...
75
```
76
+
77
+7) Additional information
78
+Some bugs require additional information such as scripts to reproduce. Please add to this section.
79
+
80
+If there are files required, email the files to InsiderSupport@microsoft.com with:
81
+Subject: Forward to WSL Team - RE: github issue <issue #>
82
+Body: "Please forward to WSL Team" and include your attachment.
83
+
84
+Common files are:
85
+Memory dumps found under C:\Windows\MEMORY.DMP
86
+Additional strace logs if the error occurs within a fork. The following command generates an output file for every fork created:
87
+
88
+```
89
+$ strace -ff -o <outputfile> <command>
90
+```