Skip to content

Commit 9e9040b

Browse files
authored
github: better bug reports please, stop removing context from logs (#1358)
1 parent 3781a08 commit 9e9040b

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,33 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
### Look for similar bugs
11+
Please check if there's [already an issue](https://github.com/librespot-org/librespot/issues) for your problem.
12+
If you've only a "me too" comment to make, consider if a :+1: [reaction](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/)
13+
will suffice.
1214

13-
**To reproduce**
14-
Steps to reproduce the behavior:
15+
### Description
16+
A clear and concise description of what the problem is.
17+
18+
### Version
19+
What version(s) of *librespot* does this problem exist in?
20+
21+
### How to reproduce
22+
Steps to reproduce the behavior in *librespot* e.g.
1523
1. Launch `librespot` with '...'
1624
2. Connect with '...'
1725
3. In the client click on '...'
18-
4. See error
26+
4. See some error/problem
1927

20-
**Log**
21-
A full log so we may trace your problem (launch `librespot` with `--verbose`). Format the log as code.
28+
### Log
29+
* A *full* **debug** log so we may trace your problem (launch `librespot` with `--verbose`).
30+
* Ideally contains your above steps to reproduce.
31+
* Format the log as code ([help](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)) or use a *non-expiring* [pastebin](https://pastebin.com/).
32+
* Redact data you consider personal but do not remove/trim anything else.
2233

23-
**Host (what you are running `librespot` on):**
34+
### Host (what you are running `librespot` on):
2435
- OS: [e.g. Linux]
2536
- Platform: [e.g. RPi 3B+]
2637

27-
**Additional context**
38+
### Additional context
2839
Add any other context about the problem here. If your issue is related to sound playback, at a minimum specify the type and make of your output device.

0 commit comments

Comments
 (0)