Make markdown headers render right CONTRIBUTING.md (#1837)
Luong Vo Tran Thanh committed
Mar 31, 2017 at 22:31 UTC
1d1ab0cb0e4bde0b603c2597fb15d9341f25475d
1 file changed
+17
-17
CONTRIBUTING.md
+17
-17
@@ -4,16 +4,16 @@ Do not open Github issues for Windows crashes (BSODs) or security issues. Pleas
4
5
A well written bug will follow the template:
6
7
-###1) Issue Title
7
+### 1) Issue Title
8
9
A title succinctly describing the issue.
10
11
-####Example:
11
+#### Example:
12
13
`Traceroute not working.`
14
15
16
-###2) Brief description
16
+### 2) Brief description
17
18
A brief description of what you are attempting to run.
19
@@ -21,7 +21,7 @@ A brief description of what you are attempting to run.
21
22
`IP_MTU_DISCOVER error when running traceroute.`
23
24
-###3) Windows version / build number
24
+### 3) Windows version / build number
25
26
Your Windows build number. This can be gathered from the CMD prompt using the `ver` command.
27
@@ -32,22 +32,22 @@ Microsoft Windows [Version 10.0.14385]
32
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.
34
35
-####Example:
35
+#### Example:
36
37
`Microsoft Windows [Version 10.0.14385]`
38
39
-###4) Steps required to reproduce
39
+### 4) Steps required to reproduce
40
41
Should include all packages and environmental variables as well as other required configuration.
42
43
-####Example:
43
+#### Example:
44
45
`$ sudo apt-get install traceroute`
46
`$ traceroute www.microsoft.com`
47
48
-###5) Copy of the terminal output
48
+### 5) Copy of the terminal output
49
50
-####Example:
50
+#### Example:
51
52
```
53
russ@RUSSALEX-BOOK:/mnt/c$ traceroute www.microsoft.com
@@ -55,11 +55,11 @@ traceroute to www.microsoft.com (23.75.239.28), 30 hops max, 60 byte packets
55
setsockopt IP_MTU_DISCOVER: Invalid argument
56
```
57
58
-###6) Expected Behavior
58
+### 6) Expected Behavior
59
60
What was the expected result of the command? Include examples / documentation if possible.
61
62
-###7) Strace of the failing command
62
+### 7) Strace of the failing command
63
64
Run the failing command under [strace] (http://manpages.ubuntu.com/manpages/wily/man1/strace.1.html). Normal command structure is:
65
@@ -69,7 +69,7 @@ $ strace <command>
69
70
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
72
-####Example:
72
+#### Example:
73
74
```
75
russ@RUSSALEX-BOOK:/mnt/c$ strace traceroute www.microsoft.com
@@ -83,7 +83,7 @@ access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory)
83
...
84
```
85
86
-###8) Additional information
86
+### 8) Additional information
87
88
Some bugs require additional information such as scripts to reproduce. Please add to this section.
89
@@ -99,10 +99,10 @@ Additional strace logs if the error occurs within a fork. The following command
99
$ strace -ff -o <outputfile> <command>
100
```
101
102
-###9) Detailed Logs
102
+### 9) Detailed Logs
103
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.
104
105
-####Start
105
+#### Start
106
107
```
108
>logman.exe create trace lxcore_kernel -p {0CD1C309-0878-4515-83DB-749843B3F5C9} -mode 0x00000008 -ft 10:00 -o .\lxcore_kernel.etl -ets
@@ -111,7 +111,7 @@ Some bugs will require more detailed logs to help determine the cause. There is
111
>logman create trace lxcore_service -p {B99CDB5A-039C-5046-E672-1A0DE0A40211} -ft 1:00 -rt -o .\lxcore_service.etl -ets
112
```
113
114
-####Stop
114
+#### Stop
115
116
```
117
>logman stop lxcore_kernel -ets
@@ -120,7 +120,7 @@ Some bugs will require more detailed logs to help determine the cause. There is
120
>logman stop lxcore_service -ets
121
```
122
123
-####Output
123
+#### Output
124
125
Files generated are in the directory where the commands above ran:
126