tilderadio
/
AzuraCast
mirror of https://github.com/AzuraCast/AzuraCast.git
4
0
Fork 0
Code Issues Releases Wiki Activity

Emphasize the importance of logs in the bug template.

This commit is contained in:
Buster "Silver Eagle" Neece 2018-10-30 03:05:21 -05:00
parent e064da4f4d
commit 4fdd589a33
2 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,41 +1,51 @@
---
name: Bug report
about: Create a report to help us improve
---
<!--
PLEASE CHECK YOUR LOGS BEFORE SUBMITTING!!
With 90% of bugs/errors, we will immediately ask you to check your logs.
Log instructions are available here:
https://github.com/AzuraCast/AzuraCast/blob/master/SUPPORT.md#troubleshooting-by-viewing-logs
-->
<!--
Do not include your responses inside the "!--" comments. Add them outside these sections.
-->
**Installation method**
Indicate whether you are using the "Docker" or "Traditional" installation method.
<!-- Indicate whether you are using the "Docker" or "Traditional" installation method. -->
**Host OS (for Docker installations)**
Indicate what your host operating system is (i.e. Ubuntu 16.04, MacOS High Sierra, Windows 10), if you're using the Docker installation method.
<!-- Indicate what your host operating system is (i.e. Ubuntu 16.04, MacOS High Sierra, Windows 10), if you're using the Docker installation method. -->
**Describe the bug**
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->
**To Reproduce**
<!--
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->
**Expected behavior**
A clear and concise description of what you expected to happen.
<!-- A clear and concise description of what you expected to happen. -->
**Relevant Logs**
<!-- Paste in any error messages or abnormal entries you see in your logs (see above). -->
**Screenshots**
If applicable, add screenshots to help explain your problem.
<!-- If applicable, add screenshots to help explain your problem. -->
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Device(s):**
- Device: <!-- [e.g. Desktop, iPhone6] -->
- OS: <!-- [e.g. iOS] -->
- Browser: <!-- [e.g. chrome, safari] -->
- Version: <!-- [e.g. 22] -->
**Additional context**
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->

2
SUPPORT.md
View File

@ -9,6 +9,8 @@ one you're experiencing. If one does not exist, create a new one.
Before submitting any GitHub issues, you should take a look at the terminal logs that AzuraCast outputs. They can often provide additional information about the error, or include very useful information that should be included in any GitHub issue you create.
Users with the appropriate permissions can also view many logs directly through AzuraCast itself. The Log Viewer feature is available under "Utilities" in each station's management page.
#### Docker
To view logs in Docker, from the directory where your `docker-compose.yml` file is located, you can run: