bug_report improvements (#7805)

* github/issue_template/bug_report.md: move specific suggestions to the appropriate sections and improve spelling
This commit is contained in:
Ilya Mashchenko 2020-01-22 23:28:42 +03:00 committed by GitHub
parent bf36a8c094
commit c21e5071bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 15 deletions

View File

@ -4,31 +4,54 @@ about: Create a bug report to help us improve
labels: bug, needs triage
---
<!---
<!--
When creating a bug report please:
- Verify first that your issue is not already reported on GitHub
- Verify first that your issue is not already reported on GitHub.
- Test if the latest release and master branch are affected too.
- Provide a clear and concise description of what the bug is in "Bug report
summary" section.
- Try to provide as much information about your environment (OS distribution,
running in container, etc.) as possible to allow us reproduce this bug faster.
- Write which component is affected. We group our components the same way our
code is structured so basically:
component name = dir in top level directory of repository
- Describe how you found this bug and how we can reproduce it. Preferable with
a minimal test-case scenario. You can paste gist.github.com links for larger
files
- Provide a clear and concise description of what you expected to happen.
-->
##### Bug report summary
<!-- Provide a clear and concise description of the bug you're experiencing. -->
##### OS / Environment (output of `uname -a; command -v sw_vers && sw_vers || grep -Hv "^#" /etc/*release`)
##### OS / Environment
<!--
Provide as much information about your environment (which operating system and distribution you're using, if Netdata is running in a container, etc.)
as possible to allow us reproduce this bug faster.
##### Netdata version (ouput of `netdata -V`)
To get this information, execute the following commands based on your operating system:
- uname -a; grep -Hv "^#" /etc/*release # Linux
- uname -a; uname -K # BSD
- uname -a; sw_vers # macOS
Place the output from the command in the code section below.
-->
```
```
##### Netdata version
<!--
Provide output of `netdata -V`.
If Netdata is running, execute: $(ps aux | grep -E -o "[a-zA-Z/]+netdata ") -V
-->
##### Component Name
<!--
Let us know which component is affected by the bug. Our code is structured according to its component,
so the component name is the same as the top level directory of the repository.
For example, a bug in the dashboard would be under the web component.
-->
##### Steps To Reproduce
<!--
Describe how you found this bug and how we can reproduce it, preferably with a minimal test-case scenario.
If you'd like to attach larger files, use gist.github.com and paste in links.
-->
1. ...
2. ...
##### Expected behavior
<!-- Provide a clear and concise description of what you expected to happen. -->