From 3b1140a419d04b4cc6e58ef12dfbe93e02c9e4d4 Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 04:48:03 +0100 Subject: [PATCH 1/8] add bug-report issue form --- .github/ISSUE_TEMPLATE/bug_report.yml | 103 ++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..ea2eef301 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,103 @@ +name: Bug Report +description: Report a bug with the software. +labels: bug +body: +- type: checkboxes + id: before-posting + attributes: + label: "This issue respects the following points:" + description: All conditions are **required**. + options: + - label: This issue is **not** already reported on [GitHub](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aopen+is%3Aissue) _(I've searched it)_. + required: true + - label: I agree to follow Jellyfin's [Code of Conduct](https://jellyfin.org/docs/general/community-standards.html#code-of-conduct). + required: true + - label: This report addresses only a single issue; If you encounter multiple issues, kindly create separate reports for each one. + required: true + + - type: markdown + attributes: + value: | + ## Software Versions + - type: input + id: jellyfin_server_version + attributes: + label: Jellyfin Server Version + placeholder: "e.g., 10.9.11 or 10.10.3" + - type: input + id: roku_version + attributes: + label: Roku Client Version + placeholder: "e.g., 2.1.8 or 2.2.5" + + - type: markdown + attributes: + value: | + ## Bug Information + - type: textarea + id: bug_description + attributes: + label: Bug Description + description: Provide a clear and concise description of what the bug is. + placeholder: "When playing a movie via the «Resume from» context menu, I get the error message «xyz»" + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps to Reproduce + description: Provide steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. Bug occurs + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: Provide a clear and concise description of what you expected to happen. + placeholder: "Describe what you expected to happen." + - type: textarea + id: logs + attributes: + label: Logs + description: Please paste any logs here. + placeholder: "Paste logs here, if available." + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem + placeholder: "Paste Screenshots here, if available." + + - type: markdown + attributes: + value: | + ## Connection Information + - type: dropdown + id: server_access_relativity + attributes: + label: Is the server local or remote? + options: + - Please select... + - local + - remote + default: 0 + - type: dropdown + id: server_access_protocol + attributes: + label: Is the server connection HTTP or HTTPS? + options: + - Please select... + - http + - https + default: 0 + + - type: markdown + attributes: + value: | + ## Additional + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: Add any other context about the problem here. From 5e68997eb7f27234210ed29e923c2c54c4566b98 Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:02:38 +0100 Subject: [PATCH 2/8] update required fields --- .github/ISSUE_TEMPLATE/bug_report.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ea2eef301..a3847e95e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -24,11 +24,15 @@ body: attributes: label: Jellyfin Server Version placeholder: "e.g., 10.9.11 or 10.10.3" + validations: + required: true - type: input id: roku_version attributes: label: Roku Client Version placeholder: "e.g., 2.1.8 or 2.2.5" + validations: + required: true - type: markdown attributes: @@ -40,6 +44,8 @@ body: label: Bug Description description: Provide a clear and concise description of what the bug is. placeholder: "When playing a movie via the «Resume from» context menu, I get the error message «xyz»" + validations: + required: true - type: textarea id: steps_to_reproduce attributes: @@ -50,24 +56,32 @@ body: 2. Click on '....' 3. Scroll down to '....' 4. Bug occurs + validations: + required: true - type: textarea id: expected_behavior attributes: label: Expected Behavior description: Provide a clear and concise description of what you expected to happen. placeholder: "Describe what you expected to happen." + validations: + required: true - type: textarea id: logs attributes: label: Logs description: Please paste any logs here. placeholder: "Paste logs here, if available." + validations: + required: false - type: textarea id: screenshots attributes: label: Screenshots description: If applicable, add screenshots to help explain your problem placeholder: "Paste Screenshots here, if available." + validations: + required: false - type: markdown attributes: @@ -82,6 +96,8 @@ body: - local - remote default: 0 + validations: + required: false - type: dropdown id: server_access_protocol attributes: @@ -91,6 +107,8 @@ body: - http - https default: 0 + validations: + required: false - type: markdown attributes: @@ -101,3 +119,5 @@ body: attributes: label: Additional Context description: Add any other context about the problem here. + validations: + required: false From 34db25c3473bfb07d57a8ebbf07db6f93d69b28a Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:04:58 +0100 Subject: [PATCH 3/8] add enhancement-request form --- .../ISSUE_TEMPLATE/enhancement-request.yml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/enhancement-request.yml diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.yml b/.github/ISSUE_TEMPLATE/enhancement-request.yml new file mode 100644 index 000000000..9d9d80247 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement-request.yml @@ -0,0 +1,36 @@ +name: Enhancement request +description: Suggest a modification to an existing feature +labels: enhancement + +body: + - type: textarea + attributes: + label: Problem Description + description: Describe the issue you are experiencing or the gap you are trying to address. + placeholder: I often encounter issues when... + validations: + required: true + + - type: textarea + attributes: + label: Proposed Solution + description: Provide a detailed description of what you would like to see implemented or changed. + placeholder: Describe the feature or change in detail. + validations: + required: true + + - type: textarea + attributes: + label: Alternatives Considered + description: Outline any other approaches you have thought about or explored to solve the problem. + placeholder: Describe any alternative solutions or features. + validations: + required: true + + - type: textarea + attributes: + label: Additional Information + description: Include any relevant details, resources, or screenshots that might help in understanding or implementing the request. + placeholder: Add any additional context here. + validations: + required: false \ No newline at end of file From 06261050e678be423eeb0ff700b58989d1bd9624 Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:12:48 +0100 Subject: [PATCH 4/8] add pre-check to enhancement form --- .github/ISSUE_TEMPLATE/enhancement-request.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.yml b/.github/ISSUE_TEMPLATE/enhancement-request.yml index 9d9d80247..fad84b9d3 100644 --- a/.github/ISSUE_TEMPLATE/enhancement-request.yml +++ b/.github/ISSUE_TEMPLATE/enhancement-request.yml @@ -3,6 +3,18 @@ description: Suggest a modification to an existing feature labels: enhancement body: + - type: checkboxes + id: before-posting + attributes: + label: "This request respects the following points:" + description: All conditions are **required**. + options: + - label: This request is **not** already on [GitHub](https://github.com/jellyfin/jellyfin-roku/labels/enhancement) _(I've searched it)_. + required: true + - label: I agree to follow Jellyfin's [Code of Conduct](https://jellyfin.org/docs/general/community-standards.html#code-of-conduct). + required: true + + - type: textarea attributes: label: Problem Description From 52e4f6988fc1259c741cba11b2a5a7cab246b52f Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:13:21 +0100 Subject: [PATCH 5/8] fix indent on bug_report form --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a3847e95e..f035930cc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -2,7 +2,7 @@ name: Bug Report description: Report a bug with the software. labels: bug body: -- type: checkboxes + - type: checkboxes id: before-posting attributes: label: "This issue respects the following points:" From e1bafe1716fd39033634fe8f3a02e15316eb7c3b Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:17:26 +0100 Subject: [PATCH 6/8] add feature request form --- .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..ad8769261 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature Request +description: Suggest a new feature +labels: feature + +body: + - type: checkboxes + id: before-posting + attributes: + label: "This request respects the following points:" + description: All conditions are **required**. + options: + - label: This request is **not** already on [GitHub](https://github.com/jellyfin/jellyfin-roku/labels/enhancement) _(I've searched it)_. + required: true + - label: I agree to follow Jellyfin's [Code of Conduct](https://jellyfin.org/docs/general/community-standards.html#code-of-conduct). + required: true + + - type: textarea + attributes: + label: Describe the feature you would like + description: Provide a clear and concise description of the feature you want to see implemented. + validations: + required: true + + - type: textarea + id: why-needed + attributes: + label: Why is this feature needed? + description: Explain why this feature would be beneficial and how it improves the project. + placeholder: "Describe why this feature would be useful." + validations: + required: false + + - type: textarea + attributes: + label: Additional Context + description: Add any additional context, resources, or screenshots that might help understand or implement the feature. + placeholder: Add any additional context or relevant details here. + validations: + required: false From c9f3c6d0f651b43724b920c7183f5708434debec Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:18:05 +0100 Subject: [PATCH 7/8] renamed old templates to "legacy" --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/enhancement-request.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index acee99b88..66e2ed9db 100755 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Bug report [legacy] about: Create a bug report title: '' labels: bug diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.md b/.github/ISSUE_TEMPLATE/enhancement-request.md index aa0656a94..bcc2ac95e 100755 --- a/.github/ISSUE_TEMPLATE/enhancement-request.md +++ b/.github/ISSUE_TEMPLATE/enhancement-request.md @@ -1,5 +1,5 @@ --- -name: Enhancement request +name: Enhancement request [legacy] about: Suggest a modification to an existing feature title: '' labels: enhancement diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bb4edd385..dc946a9bd 100755 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Feature request +name: Feature request [legacy] about: Suggest a new feature title: '' labels: feature From c4d91176e5693e7e6312a0f313d99a413a750b9e Mon Sep 17 00:00:00 2001 From: BotBlake Date: Sat, 21 Dec 2024 05:33:51 +0100 Subject: [PATCH 8/8] added newline at the end --- .github/ISSUE_TEMPLATE/enhancement-request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.yml b/.github/ISSUE_TEMPLATE/enhancement-request.yml index fad84b9d3..2cfed69ac 100644 --- a/.github/ISSUE_TEMPLATE/enhancement-request.yml +++ b/.github/ISSUE_TEMPLATE/enhancement-request.yml @@ -45,4 +45,4 @@ body: description: Include any relevant details, resources, or screenshots that might help in understanding or implementing the request. placeholder: Add any additional context here. validations: - required: false \ No newline at end of file + required: false