bug_report improvements (#7805)
* github/issue_template/bug_report.md: move specific suggestions to the appropriate sections and improve spelling
Ilya Mashchenko committed
Jan 22, 2020 at 23:28 UTC
c21e5071bcc5f95867e57f3d18a9ac9be79b3716
1 file changed
+38
-15
.github/ISSUE_TEMPLATE/bug_report.md
+38
-15
@@ -4,31 +4,54 @@ about: Create a bug report to help us improve
4
labels: bug, needs triage
5
---
6
7
-<!---
7
+<!--
8
When creating a bug report please:
9
-- Verify first that your issue is not already reported on GitHub
9
+- Verify first that your issue is not already reported on GitHub.
10
- Test if the latest release and master branch are affected too.
11
-- Provide a clear and concise description of what the bug is in "Bug report
12
- summary" section.
13
-- Try to provide as much information about your environment (OS distribution,
14
- running in container, etc.) as possible to allow us reproduce this bug faster.
15
-- Write which component is affected. We group our components the same way our
16
- code is structured so basically:
17
- component name = dir in top level directory of repository
18
-- Describe how you found this bug and how we can reproduce it. Preferable with
19
- a minimal test-case scenario. You can paste gist.github.com links for larger
20
- files
21
-- Provide a clear and concise description of what you expected to happen.
11
-->
12
13
##### Bug report summary
14
+<!-- Provide a clear and concise description of the bug you're experiencing. -->
15
26
-##### OS / Environment (output of `uname -a; command -v sw_vers && sw_vers || grep -Hv "^#" /etc/*release`)
16
+##### OS / Environment
17
+<!--
18
+Provide as much information about your environment (which operating system and distribution you're using, if Netdata is running in a container, etc.)
19
+as possible to allow us reproduce this bug faster.
20
28
-##### Netdata version (ouput of `netdata -V`)
21
+To get this information, execute the following commands based on your operating system:
22
+- uname -a; grep -Hv "^#" /etc/*release # Linux
23
+- uname -a; uname -K # BSD
24
+- uname -a; sw_vers # macOS
25
+
26
+Place the output from the command in the code section below.
27
+ -->
28
+```
29
+
30
+```
31
+
32
+##### Netdata version
33
+<!--
34
+Provide output of `netdata -V`.
35
+
36
+If Netdata is running, execute: $(ps aux | grep -E -o "[a-zA-Z/]+netdata ") -V
37
+ -->
38
+
39
40
##### Component Name
41
+<!--
42
+Let us know which component is affected by the bug. Our code is structured according to its component,
43
+so the component name is the same as the top level directory of the repository.
44
+For example, a bug in the dashboard would be under the web component.
45
+-->
46
47
##### Steps To Reproduce
48
+<!--
49
+Describe how you found this bug and how we can reproduce it, preferably with a minimal test-case scenario.
50
+If you'd like to attach larger files, use gist.github.com and paste in links.
51
+-->
52
+
53
+1. ...
54
+2. ...
55
56
##### Expected behavior
57
+<!-- Provide a clear and concise description of what you expected to happen. -->