From c06c046c480cb8e61c918149a9864f922dc2391f Mon Sep 17 00:00:00 2001 From: TheMeanCanEHdian Date: Sat, 7 Aug 2021 10:12:30 -0500 Subject: [PATCH 1/3] Convert issue templates to forms. --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 96 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 31 +++++++ .github/ISSUE_TEMPLATE/bug_report.md | 49 ----------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- 4 files changed, 127 insertions(+), 69 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 00000000..ccc2331b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,96 @@ +name: Bug Report +description: Please do not use bug reports for support issues. +labels: ['status:awaiting-triage', 'type:bug'] +body: + - type: markdown + attributes: + value: | + **THIS IS NOT THE PLACE TO ASK FOR SUPPORT!** Please use [Discord](https://tautulli.com/discord) for support issues. + - type: textarea + id: description + attributes: + label: Describe the Bug + placeholder: A clear and concise description of the bug. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + - type: textarea + id: expected + attributes: + label: Expected Behavior + placeholder: A clear and concise description of what you expected to happen. + - type: textarea + id: screenshots + attributes: + label: Screenshots + placeholder: Provide screenshots to help explain your problem. + - type: textarea + id: relevant + attributes: + label: Relevant Settings + placeholder: | + - eg. Plex Media Server IP address/port/checkboxes/proxy/etc. + - eg. Notification agent configuration/triggers/conditions/text/delay/grouping/etc. + - eg. Newsletter agent configuration/checkboxes/template/etc. + - Other settings + - type: input + id: version + attributes: + label: Tautulli Version + placeholder: ex. v2.7.5 (check Tautulli Settings > Help & Info page) + validations: + required: true + - type: input + id: branch + attributes: + label: Git Branch + placeholder: ex. master (check Tautulli Settings > Help & Info page) + validations: + required: true + - type: input + id: hash + attributes: + label: Git Commit Hash + placeholder: ex. `2cc5bf812fe05e0666aeaeb37ed550c59816fb4c` (check Tautulli Settings > Help & Info page) + validations: + required: true + - type: input + id: platform + attributes: + label: Platform and Version + placeholder: ex. Windows 10 (check Tautulli Settings > Help & Info page) + validations: + required: true + - type: input + id: python + attributes: + label: Python Version + placeholder: ex. 3.8.10 (check Tautulli Settings > Help & Info page) + validations: + required: true + - type: input + id: browser + attributes: + label: Browser and Version + placeholder: ex. Chrome 88 + validations: + required: true + - type: input + id: logs + attributes: + label: Link to logs + placeholder: Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). _Do not upload attachments_. + validations: + required: true + - type: markdown + attributes: + value: | + Make sure to close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 00000000..a677c627 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: Suggest a new feature for Tautulli. +labels: ['status:awaiting-triage', 'type:enhancement'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to help improve Tautulli! + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: If so, please describe the problem. + placeholder: A clear and concise description of what the problem (if any) is. Ex. I'm always frustrated when '...' + - type: textarea + id: feature + attributes: + label: What is your feature request? + placeholder: A clear and concise description of the feature. + validations: + required: true + - type: textarea + id: workaround + attributes: + label: Are there any workarounds? + placeholder: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional + attributes: + label: Additional Context + placeholder: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0ce4d436..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -name: Bug Report -about: Please do not use bug reports for support issues. -title: '' -labels: 'status:awaiting-triage, type:bug' -assignees: '' - ---- - - - -**Describe the Bug** -A clear and concise description of what the bug is. - -**Steps to Reproduce** -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. - -**Screenshots** -Provide screenshots to help explain your problem. - -**Relevant Settings** -- eg. Plex Media Server IP address/port/checkboxes/proxy/etc. -- eg. Notification agent configuration/triggers/conditions/text/delay/grouping/etc. -- eg. Newsletter agent configuration/checkboxes/template/etc. -- Other settings - -**Tautulli and System Info (see Tautulli settings page)** -- Version: [eg. v2.6.6] -- Git Branch: [eg. master] -- Git Commit Hash: [eg. 2cc5bf812fe05e0666aeaeb37ed550c59816fb4c] -- Platform and Version: [eg. Windows 10] -- Python Version: [e.g. 3.8.8] -- Browser and Version: [e.g. Chrome 88] - -**Link to logs (required)** -Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). _Do not upload attachments_. - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 747aefd6..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature for Tautulli. -title: '' -labels: 'status:awaiting-triage, type:enhancement' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. From 2aaa15793af48349eb39fb6f2aa0a558137482e2 Mon Sep 17 00:00:00 2001 From: TheMeanCanEHdian Date: Sat, 7 Aug 2021 10:25:14 -0500 Subject: [PATCH 2/3] Fix formatting of placeholders and use descriptions. --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index ccc2331b..79eba6ec 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -45,35 +45,40 @@ body: id: version attributes: label: Tautulli Version - placeholder: ex. v2.7.5 (check Tautulli Settings > Help & Info page) + description: Check Tautulli Settings > Help & Info page. + placeholder: ex. v2.7.5 validations: required: true - type: input id: branch attributes: label: Git Branch - placeholder: ex. master (check Tautulli Settings > Help & Info page) + description: Check Tautulli Settings > Help & Info page. + placeholder: ex. master validations: required: true - type: input id: hash attributes: label: Git Commit Hash - placeholder: ex. `2cc5bf812fe05e0666aeaeb37ed550c59816fb4c` (check Tautulli Settings > Help & Info page) + description: Check Tautulli Settings > Help & Info page. + placeholder: ex. 2cc5bf812fe05e0666aeaeb37ed550c59816fb4c validations: required: true - type: input id: platform attributes: label: Platform and Version - placeholder: ex. Windows 10 (check Tautulli Settings > Help & Info page) + description: Check Tautulli Settings > Help & Info page. + placeholder: ex. Windows 10 validations: required: true - type: input id: python attributes: label: Python Version - placeholder: ex. 3.8.10 (check Tautulli Settings > Help & Info page) + description: Check Tautulli Settings > Help & Info page. + placeholder: ex. 3.8.10 validations: required: true - type: input @@ -87,7 +92,8 @@ body: id: logs attributes: label: Link to logs - placeholder: Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). _Do not upload attachments_. + description: Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). _Do not upload attachments_. + placeholder: Gist link to logs validations: required: true - type: markdown From f28a4e92b45da4579e2f473b9af547482adde640 Mon Sep 17 00:00:00 2001 From: TheMeanCanEHdian Date: Sat, 7 Aug 2021 11:17:23 -0500 Subject: [PATCH 3/3] Update various formatting items. - Change `ex.` to `eg.` - Move non-example placeholders to descriptions - Add description to Steps to Reproduce & Relevant Settings --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 25 +++++++++++----------- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 10 ++++----- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 79eba6ec..34f617df 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -10,13 +10,14 @@ body: id: description attributes: label: Describe the Bug - placeholder: A clear and concise description of the bug. + description: A clear and concise description of the bug. validations: required: true - type: textarea id: steps attributes: label: Steps to Reproduce + description: List each action required in order to reproduce the issue. placeholder: | 1. Go to '...' 2. Click on '...' @@ -26,16 +27,17 @@ body: id: expected attributes: label: Expected Behavior - placeholder: A clear and concise description of what you expected to happen. + description: A clear and concise description of what you expected to happen. - type: textarea id: screenshots attributes: label: Screenshots - placeholder: Provide screenshots to help explain your problem. + description: Provide screenshots to help explain your problem. - type: textarea id: relevant attributes: label: Relevant Settings + description: Include all settings/configuration that are relevant to your issue. For example, Plex Media Server, newsletter, or notification settings. placeholder: | - eg. Plex Media Server IP address/port/checkboxes/proxy/etc. - eg. Notification agent configuration/triggers/conditions/text/delay/grouping/etc. @@ -46,7 +48,7 @@ body: attributes: label: Tautulli Version description: Check Tautulli Settings > Help & Info page. - placeholder: ex. v2.7.5 + placeholder: eg. v2.7.5 validations: required: true - type: input @@ -54,7 +56,7 @@ body: attributes: label: Git Branch description: Check Tautulli Settings > Help & Info page. - placeholder: ex. master + placeholder: eg. master validations: required: true - type: input @@ -62,7 +64,7 @@ body: attributes: label: Git Commit Hash description: Check Tautulli Settings > Help & Info page. - placeholder: ex. 2cc5bf812fe05e0666aeaeb37ed550c59816fb4c + placeholder: eg. 2cc5bf812fe05e0666aeaeb37ed550c59816fb4c validations: required: true - type: input @@ -70,7 +72,7 @@ body: attributes: label: Platform and Version description: Check Tautulli Settings > Help & Info page. - placeholder: ex. Windows 10 + placeholder: eg. Windows 10 validations: required: true - type: input @@ -78,22 +80,21 @@ body: attributes: label: Python Version description: Check Tautulli Settings > Help & Info page. - placeholder: ex. 3.8.10 + placeholder: eg. 3.8.10 validations: required: true - type: input id: browser attributes: label: Browser and Version - placeholder: ex. Chrome 88 + placeholder: eg. Chrome 88 validations: required: true - type: input id: logs attributes: - label: Link to logs - description: Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). _Do not upload attachments_. - placeholder: Gist link to logs + label: Link to Logs + description: Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). validations: required: true - type: markdown diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml index a677c627..70e2ab33 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -10,22 +10,22 @@ body: id: problem attributes: label: Is your feature request related to a problem? - description: If so, please describe the problem. - placeholder: A clear and concise description of what the problem (if any) is. Ex. I'm always frustrated when '...' + description: If so, please provide clear and concise description of the problem. + placeholder: eg. I'm always frustrated when '...' - type: textarea id: feature attributes: label: What is your feature request? - placeholder: A clear and concise description of the feature. + description: A clear and concise description of the feature. validations: required: true - type: textarea id: workaround attributes: label: Are there any workarounds? - placeholder: A clear and concise description of any alternative solutions or features you've considered. + description: A clear and concise description of any alternative solutions or features you've considered. - type: textarea id: additional attributes: label: Additional Context - placeholder: Add any other context or screenshots about the feature request here. + description: Add any other context or screenshots about the feature request here.