From b0e33970b8f8fa99e3618b99b7684238f971ed9c Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Sun, 5 May 2024 16:35:26 +0000 Subject: [PATCH 1/7] Add more fields to bug report template --- .github/ISSUE_TEMPLATE/bug.yaml | 99 ++++++++++++++++++++++++++++----- 1 file changed, 86 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 7f47d710..05c0165a 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -1,40 +1,51 @@ name: 🐞 Bug Report -description: File a bug/issue -title: "[Bug]: " -labels: ["bug", "triage"] +description: File a bug/issue and help us improve Audiobookshelf +title: '[Bug]: ' +labels: ['bug', 'triage'] body: - type: markdown attributes: - value: "### Please first search for your issue and check the [docs](https://audiobookshelf.org/docs)." + value: 'Thank you for filing a bug report! 🐛' - type: markdown attributes: - value: "### Mobile app issues report [here](https://github.com/advplyr/audiobookshelf-app/issues/new/choose)." + value: 'Please first search for your issue and check the [docs](https://audiobookshelf.org/docs).' - type: markdown attributes: - value: "### Join the [discord server](https://discord.gg/HQgCbd6E75) for questions or if you are not sure about a bug." + value: 'Mobile app issues report [here](https://github.com/advplyr/audiobookshelf-app/issues/new/choose).' - type: markdown attributes: - value: "## Be as descriptive as you can. Include screenshots, error logs, browser, file types, everything you can think of that might be relevant." + value: 'Join the [discord server](https://discord.gg/HQgCbd6E75) for questions or if you are not sure about a bug.' - type: textarea id: what-happened attributes: - label: Describe the issue - description: What happened & what did you expect to happen + label: What happened? + description: Don't forget to tell us what steps you took so we can try to reproduce. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: what-was-expected + attributes: + label: What did you expect to happen? + placeholder: Tell us what you expected to see! Be as descriptive as you can and include screenshots if applicable. validations: required: true - type: textarea id: steps-to-reproduce attributes: label: Steps to reproduce the issue - value: "1. " + value: '1. ' validations: required: true + - type: markdown + attributes: + value: '### Install Environment' - type: input id: version attributes: label: Audiobookshelf version description: Do not put 'Latest version', please put the actual version here - placeholder: "e.g. v1.6.60" + placeholder: 'e.g. v1.6.60' validations: required: true - type: dropdown @@ -46,6 +57,68 @@ body: - Debian/PPA - Windows Tray App - Built from source - - Other + - Other (list in "Additional Notes" box) validations: - required: true + required: true + - type: markdown + attributes: + value: '### Desktop Environment' + - type: dropdown + id: desktop-os + label: If the issue is being seen on Desktop, what OS are you running where you see the issue? + attributes: + label: Operating System + options: + - Windows + - macOS + - Linux + - Other (list in "Additional Notes" box) + validations: + required: true + - type: dropdown + id: desktop-browsers + label: If the issue is being seen in the UI, what browsers are you seeing the problem on? + attributes: + label: Desktop Browser + options: + - Chrome + - Firefox + - Safari + - Edge + - Other (list in "Additional Notes" box) + - type: markdown + attributes: + value: '### Mobile Environment' + - type: dropdown + id: mobile-os + label: If the issue is being seen on Mobile, what OS are you running where you see the issue? + attributes: + label: Operating System + options: + - Android + - iOS + - Other (list in "Additional Notes" box) + - type: dropdown + id: mobile-browsers + label: If the issue is being seen in the UI, what browsers are you seeing the problem on? + attributes: + label: Mobile Browser + options: + - Chrome + - Firefox + - Safari + - Edge + - Other (list in "Additional Notes" box) + - type: textarea + id: logs + attributes: + label: Logs + description: Please include any relevant logs here. This field is automatically formatted into code, so you do not need to include any backticks. + placeholder: Paste logs here + render: shell + - type: textarea + id: additional-notes + attributes: + label: Additional Notes + description: Anything else you want to add? + placeholder: 'e.g. I have tried X, Y, and Z.' From dfe6505af0e7f61cf73fa300ee145eae0e8f7077 Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Sun, 5 May 2024 16:37:11 +0000 Subject: [PATCH 2/7] Fix: label placement --- .github/ISSUE_TEMPLATE/bug.yaml | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 05c0165a..69b1bdc2 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -65,9 +65,8 @@ body: value: '### Desktop Environment' - type: dropdown id: desktop-os - label: If the issue is being seen on Desktop, what OS are you running where you see the issue? attributes: - label: Operating System + label: If the issue is being seen on Desktop, what OS are you running where you see the issue? options: - Windows - macOS @@ -77,9 +76,8 @@ body: required: true - type: dropdown id: desktop-browsers - label: If the issue is being seen in the UI, what browsers are you seeing the problem on? attributes: - label: Desktop Browser + label: If the issue is being seen in the UI, what browsers are you seeing the problem on? options: - Chrome - Firefox @@ -91,18 +89,16 @@ body: value: '### Mobile Environment' - type: dropdown id: mobile-os - label: If the issue is being seen on Mobile, what OS are you running where you see the issue? attributes: - label: Operating System + label: If the issue is being seen on Mobile, what OS are you running where you see the issue? options: - Android - iOS - Other (list in "Additional Notes" box) - type: dropdown id: mobile-browsers - label: If the issue is being seen in the UI, what browsers are you seeing the problem on? attributes: - label: Mobile Browser + label: If the issue is being seen in the UI, what browsers are you seeing the problem on? options: - Chrome - Firefox From fa5d2b2020e5e7a3271f161e23c769581d784f6d Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Sun, 5 May 2024 16:37:48 +0000 Subject: [PATCH 3/7] Fix: label tabbing --- .github/ISSUE_TEMPLATE/bug.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 69b1bdc2..de233808 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -90,7 +90,7 @@ body: - type: dropdown id: mobile-os attributes: - label: If the issue is being seen on Mobile, what OS are you running where you see the issue? + label: If the issue is being seen on Mobile, what OS are you running where you see the issue? options: - Android - iOS From 047c8ec0178b91890f73a339c808c8d6fe340476 Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Sun, 5 May 2024 16:44:00 +0000 Subject: [PATCH 4/7] Formatting updates --- .github/ISSUE_TEMPLATE/bug.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index de233808..70159801 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -11,7 +11,7 @@ body: value: 'Please first search for your issue and check the [docs](https://audiobookshelf.org/docs).' - type: markdown attributes: - value: 'Mobile app issues report [here](https://github.com/advplyr/audiobookshelf-app/issues/new/choose).' + value: 'Report issues with the mobile app [here](https://github.com/advplyr/audiobookshelf-app/issues/new/choose).' - type: markdown attributes: value: 'Join the [discord server](https://discord.gg/HQgCbd6E75) for questions or if you are not sure about a bug.' @@ -19,7 +19,6 @@ body: id: what-happened attributes: label: What happened? - description: Don't forget to tell us what steps you took so we can try to reproduce. placeholder: Tell us what you see! validations: required: true @@ -39,7 +38,7 @@ body: required: true - type: markdown attributes: - value: '### Install Environment' + value: '## Install Environment' - type: input id: version attributes: @@ -62,7 +61,7 @@ body: required: true - type: markdown attributes: - value: '### Desktop Environment' + value: '## Desktop Environment' - type: dropdown id: desktop-os attributes: @@ -86,7 +85,7 @@ body: - Other (list in "Additional Notes" box) - type: markdown attributes: - value: '### Mobile Environment' + value: '## Mobile Environment' - type: dropdown id: mobile-os attributes: From 68bfcb2e6e3b036a7b1e9e2cc1c12d65052b2556 Mon Sep 17 00:00:00 2001 From: advplyr Date: Sun, 5 May 2024 16:51:12 -0500 Subject: [PATCH 5/7] Update .github/ISSUE_TEMPLATE/bug.yaml --- .github/ISSUE_TEMPLATE/bug.yaml | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 70159801..59ca126d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -83,27 +83,6 @@ body: - Safari - Edge - Other (list in "Additional Notes" box) - - type: markdown - attributes: - value: '## Mobile Environment' - - type: dropdown - id: mobile-os - attributes: - label: If the issue is being seen on Mobile, what OS are you running where you see the issue? - options: - - Android - - iOS - - Other (list in "Additional Notes" box) - - type: dropdown - id: mobile-browsers - attributes: - label: If the issue is being seen in the UI, what browsers are you seeing the problem on? - options: - - Chrome - - Firefox - - Safari - - Edge - - Other (list in "Additional Notes" box) - type: textarea id: logs attributes: From 04a7f24bacf80d9bb18e845f0acd80f1d988f692 Mon Sep 17 00:00:00 2001 From: advplyr Date: Sun, 5 May 2024 16:51:17 -0500 Subject: [PATCH 6/7] Update .github/ISSUE_TEMPLATE/bug.yaml --- .github/ISSUE_TEMPLATE/bug.yaml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 59ca126d..1aa597e8 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -59,13 +59,10 @@ body: - Other (list in "Additional Notes" box) validations: required: true - - type: markdown - attributes: - value: '## Desktop Environment' - type: dropdown - id: desktop-os + id: server-os attributes: - label: If the issue is being seen on Desktop, what OS are you running where you see the issue? + label: What OS is your Audiobookshelf server hosted from? options: - Windows - macOS From ff5cbae0594a61e66b90a9d20bc8a1fac75d3914 Mon Sep 17 00:00:00 2001 From: advplyr Date: Sun, 5 May 2024 16:51:55 -0500 Subject: [PATCH 7/7] Update .github/ISSUE_TEMPLATE/bug.yaml --- .github/ISSUE_TEMPLATE/bug.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 1aa597e8..89aec401 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -79,6 +79,9 @@ body: - Firefox - Safari - Edge + - Firefox for Android + - Chrome for Android + - Safari on iOS - Other (list in "Additional Notes" box) - type: textarea id: logs