frodovdr/raspap-webgui
1
0
Fork 0
mirror of https://github.com/billz/raspap-webgui.git synced 2023-10-10 13:37:24 +02:00
Code Issues Releases Wiki Activity

Updated Reporting issues (markdown)

Bill Zimmerman 2020-04-06 20:06:38 +02:00
parent f3ec97be30
commit ea2456e3a5
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Reporting-issues.md

@ -1,5 +1,8 @@
## Preamble ## Preamble
RaspAP is a project currently led by one developer ([@billz](https://github.com/billz)) in his very limited spare time. As a result, issues are reserved for reporting bugs only. Troubleshooting requests will not be considered. If your issue is of a general nature and not directly related to a defect with this project, try searching the official [Raspberry Pi forums](https://www.raspberrypi.org/forums/) or [Raspberry Pi on Stack Exchange](https://raspberrypi.stackexchange.com/). Chances are your question has been discussed and answered before. RaspAP is free software. It is delivered to you, at no cost, and with no guarantee. The [community of developers](https://github.com/billz/raspap-webgui/graphs/contributors) who contribute to this project make every effort to deliver defect-free code. That said, no software is perfect. You can help us improve this project by accurately describing your issue.
## Issue policy
This project is currently led by one developer ([@billz](https://github.com/billz)) in his very limited spare time. Please respect our developers' time by using issues for reporting bugs only. RaspAP is not a boxed product with a free troubleshooting hotline. If your issue is of a general nature and not directly related to a defect with this project, try searching the official [Raspberry Pi forums](https://www.raspberrypi.org/forums/) or [Raspberry Pi on Stack Exchange](https://raspberrypi.stackexchange.com/). Chances are your question has been discussed and answered before.
The project [FAQ](https://github.com/billz/raspap-webgui/wiki/FAQs) is continuously updated with answers to many common questions. Refer to this first before creating a new issue. The project [FAQ](https://github.com/billz/raspap-webgui/wiki/FAQs) is continuously updated with answers to many common questions. Refer to this first before creating a new issue.
@ -9,8 +12,9 @@ You can help us improve this project by accurately describing defects. To that e
1. The bug report template is there for a reason. Please use it. 1. The bug report template is there for a reason. Please use it.
2. Provide useful detail to reproduce your issue. "Doesn't work" or "not working" is not a valid report. 2. Provide useful detail to reproduce your issue. "Doesn't work" or "not working" is not a valid report.
3. Issues created without the template will be labeled as `invalid` and closed immediately. 3. Issues created without the template will be labeled as `invalid` and closed immediately.
4. If an issue is unclear or needs further information, it will be labeled with `question` and `awaiting-user`. 4. Log data can be very helpful in context, within reasonable limits.
5. Issues that becomes stale due to inactivity are automatically managed by stale-bot. 5. If an issue is unclear or needs further information, it will be labeled with `question` and `awaiting-user`.
6. Issues that becomes stale due to inactivity are automatically managed by stale-bot.
## Supported devices ## Supported devices
RaspAP functions very well "out of the box" on fresh installs of the latest Raspbian distribution (currently Buster; the Lite version is recommended) on recent hardware like the RPi 4, 3B+ and Zero W. The [version 2.3.1 release](https://github.com/billz/raspap-webgui/releases/tag/2.3.1) extends beta support to additional Debian-based distros, including Armbian and Ubuntu Server. Please note that "supported" is [not a guarantee](https://github.com/billz/raspap-webgui#supported-operating-systems). RaspAP functions very well "out of the box" on fresh installs of the latest Raspbian distribution (currently Buster; the Lite version is recommended) on recent hardware like the RPi 4, 3B+ and Zero W. The [version 2.3.1 release](https://github.com/billz/raspap-webgui/releases/tag/2.3.1) extends beta support to additional Debian-based distros, including Armbian and Ubuntu Server. Please note that "supported" is [not a guarantee](https://github.com/billz/raspap-webgui#supported-operating-systems).
@ -33,3 +37,4 @@ Because of this, issues such as "hotspot isn't working" or "gui doesn't work" wo
## Submitting an issue ## Submitting an issue
If, after searching these community forums, consulting the FAQ and understanding the default settings, your issue still persists, please provide as much detailed information as possible. Use the provided issue template. Incomplete issue reports will not be considered. If, after searching these community forums, consulting the FAQ and understanding the default settings, your issue still persists, please provide as much detailed information as possible. Use the provided issue template. Incomplete issue reports will not be considered.
Thanks.