Skip to content

Commit 959b2fa

Browse files
docs update
1 parent a34fa1c commit 959b2fa

File tree

5 files changed

+40
-21
lines changed

5 files changed

+40
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Create a bug report
44
title: ''
55
labels: bug
66
assignees: iloveicedgreentea
@@ -20,12 +20,18 @@ Steps to reproduce the behavior:
2020
**Expected behavior**
2121
A clear and concise description of what you expected to happen.
2222

23+
**Configuration**
24+
Navigate to (your-server-ip):9999/debug and paste the output here
25+
26+
**Error logs**
27+
Paste the exact error message you get
28+
2329
**Debug logs**
24-
Run the program with LOG_LEVEL=debug and send me the entire log output from start to finish
30+
Run the program with LOG_LEVEL=debug and send me the entire log output while you trigger the bug, if possible.
2531

26-
**Desktop (please complete the following information):**
32+
**Info (please complete the following information):**
2733
- OS: [Windows, Unraid, etc]
28-
- Version [e.g. 22]
34+
- Version [e.g. 1.2]
2935
- Deployment method: [Docker, binary]
3036

3137
**Additional context**

.github/ISSUE_TEMPLATE/feature_request.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,16 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: ''
6-
assignees: ''
5+
labels: 'feature'
6+
assignees: 'iloveicedgreentea'
77

88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
A clear and concise description of what the problem is. Ex. I'm frustrated when [...]
1212

1313
**Describe the solution you'd like**
1414
A clear and concise description of what you want to happen.
1515

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
18-
1916
**Additional context**
2017
Add any other context or screenshots about the feature request here.

Contributing.MD

+9-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
# Contributing rules
1+
# Contributing Rules
22

3-
## Rules
3+
## Pull Requests
4+
Pull requests *will not be accepted*. If you have a change you want to make, create an issue and I will look at it.
45

5-
1) No major rewrites accepted. Sorry, don't have time to go through all that
6+
## Feature Requests
7+
All feature requests must follow the template.
68

7-
2) Functional changes will not be looked at without a detailed explanation for why it is beneficial
9+
## Issues
10+
Issues should be used for bug reports. Please follow the template when creating an issue.
811

9-
3) I am doing this in my free time, you aren't entitled to anything
10-
11-
4) If you have a request, create an issue
12-
13-
5) Hacktoberfest and the like are not welcome
14-
15-
6) Please don't make useless PRs
12+
## Support
13+
Use the Discussions tab for support.

Contributing.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing Rules
2+
3+
## Pull Requests
4+
Pull requests *will not be accepted*. If you have a change you want to make, create an issue and I will look at it.
5+
6+
## Feature Requests
7+
All feature requests must follow the template.
8+
9+
## Issues
10+
Issues should be used for bug reports. Please follow the template when creating an issue.
11+
12+
## Support
13+
Use the Discussions tab for support.

readme.md

+5
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
- [Setup](#setup)
3333
- [Usage](#usage)
3434
- [Home Assistant Quickstart](#Home-Assistant-Quickstart)
35+
- [How BEQ Support Works](#How-BEQ-Support-Works)
36+
- [Help](#help)
3537

3638
## Features
3739

@@ -368,3 +370,6 @@ English (FLAC 5.1) --- English (FLAC 5.1)
368370
English (EAC3 Stereo) --- English (EAC3 Stereo)
369371
English (EAC3 5.1) --- Main Audio (English EAC3 5.1)
370372
English (EAC3 5.1) --- English (EAC3 5.1)
373+
374+
## Help
375+
If you need help or support due to an error or bug, you must file an issue. If you have a general question, you can ask in the Discussions tab or the AVS Forum post (linked as website above)

0 commit comments

Comments
 (0)