From 3ca07ec0dfe8889281d78b6d516d361839766408 Mon Sep 17 00:00:00 2001 From: ilike2burnthing <59480337+ilike2burnthing@users.noreply.github.com> Date: Tue, 14 Sep 2021 07:29:12 +0100 Subject: [PATCH] issue template: change to github issue form (#12300) Co-authored-by: garfield69 --- .github/ISSUE_TEMPLATE.md | 36 -------------- .github/ISSUE_TEMPLATE/bug_report.yml | 58 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 29 +++++++++++ .github/ISSUE_TEMPLATE/indexer-request.yml | 33 ++++++++++++ src/Jackett.Common/Content/custom.js | 16 +++--- src/Jackett.Common/Content/index.html | 2 +- 7 files changed, 132 insertions(+), 43 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/indexer-request.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 4cbeda90e..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,36 +0,0 @@ -### Read and complete in full with information about your setup and issue before submitting. -### Do not delete the template. - -**Please use the search bar** at the top of the page and make sure you are not creating an already submitted issue. -Check closed issues as well, because your issue may have already been fixed. Also check our [Troubleshooting](https://github.com/Jackett/Jackett/wiki/Troubleshooting) for steps to resolve common issues. - -Please read our [Contributing Guidelines](https://github.com/Jackett/Jackett/blob/master/CONTRIBUTING.md) before submitting your issue to ensure a prompt response to your bug. - -### Environment - -**OS**: - -**.Net Runtime**: [.Net-Core/.Net-Framework/Mono] - -**.Net Version**: - -**Jackett Version**: - -**Last Working Jackett Version**: - -**Are you using a proxy or VPN?** [yes/no] - -### Description - -[List steps to reproduce the error and details on what happens and what you expected to happen] - - -### Logged Error Messages - -[Place any relevant error messages you noticed from the logs here.] - -[Make sure you attach the full logs with your personal information removed in case we need more information] - -### Screenshots - -[Place any screenshots of the issue here if needed] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..622fcda35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +name: Bug report +description: Create a report of your issue +body: +- type: checkboxes + attributes: + label: Have you checked our Troubleshooting page for your issue? + description: Please read the Troubleshooting page for steps to resolve common issues. + options: + - label: I have checked the Troubleshooting page + required: true +- type: checkboxes + attributes: + label: Is there already an issue for your problem? + description: Please make sure you are not creating an already submitted Issue. Check closed issues as well, because your issue may have already been fixed. + options: + - label: I have checked older issues, open and closed + required: true +- type: checkboxes + attributes: + label: Have you read our Contributing Guidelines? + description: Please read our Contributing Guidelines before submitting your issue to ensure a prompt response to your bug. + options: + - label: I have read the Contributing Guidelines + required: true +- type: textarea + attributes: + label: Environment + description: Please provide the details of the system Jackett is running on. + value: | + - OS: + - .Net Runtime: [.Net-Core/.Net-Framework/Mono] + - .Net Version: + - Jackett Version: + - Last Working Jackett Version: + - Are you using a proxy or VPN? [yes/no] + render: markdown + validations: + required: true +- type: textarea + attributes: + label: Description + description: List steps to reproduce the error and details on what happens and what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Logged Error Messages + description: | + Place any relevant error messages you noticed from the logs here. + Make sure you attach the full logs with your personal information removed in case we need more information. + validations: + required: true +- type: textarea + attributes: + label: Screenshots + description: Place any screenshots of the issue here if needed + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..6d2fd5785 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,29 @@ +name: Feature request +description: Suggest an idea for this project +title: "[req]: " +body: +- type: checkboxes + attributes: + label: Is there already a request for your feature? + description: Please make sure you are not creating an already submitted request. Check closed issues as well, because your request may have already been implemented or rejected. + options: + - label: I have checked older issues, open and closed + required: true +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/indexer-request.yml b/.github/ISSUE_TEMPLATE/indexer-request.yml new file mode 100644 index 000000000..72df37622 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/indexer-request.yml @@ -0,0 +1,33 @@ +name: Indexer request +description: Suggest a new indexer for this project +title: "[req]: " +body: +- type: checkboxes + attributes: + label: Is there already a request for your tracker? + description: Please make sure you are not creating an already submitted request. Check closed issues as well, because your request may have already been added or rejected. + options: + - label: I have checked older issues, open and closed + required: true +- type: textarea + attributes: + label: Tracker details + description: | + Please provide the details of your tracker. + Example: + - Name: TrackerX + - URL: https://trackerx.yz + - Description: TrackerX is a Private Torrent Tracker for Movies, TV, and e-Learning + - Public, Semi-private, or Private: Private + - Minimum Seeding Time and Minimum Ratio (if Private): MST 24hrs, MR 1.0 + - Additional Comments: IMDB search has to be enabled in account settings, often has hcaptcha at login + value: | + - Name: + - URL: + - Description: + - Public, Semi-private, or Private: + - Minimum Seeding Time and Minimum Ratio (if Private): + - Additional Comments: + render: markdown + validations: + required: true diff --git a/src/Jackett.Common/Content/custom.js b/src/Jackett.Common/Content/custom.js index fb7dd6888..1b58dbf4d 100644 --- a/src/Jackett.Common/Content/custom.js +++ b/src/Jackett.Common/Content/custom.js @@ -546,15 +546,17 @@ function addIndexer(indexerId, displayNotification) { doNotify("Configuration failed: " + data.error, "danger", "glyphicon glyphicon-alert"); } }).fail(function (data) { + var indexEnd = 2048 - "https://github.com/Jackett/Jackett/issues/new?template=bug_report.yml&title=[".length - indexerId.length - "] ".length - " (Config)".length; // keep url <= 2k #5104 if (data.responseJSON.error !== undefined) { - var indexEnd = 2048 - "https://github.com/Jackett/Jackett/issues/new?title=[".length - indexerId.length - "] ".length - " (Config)".length; // keep url <= 2k #5104 var githubrepo = "Jackett/Jackett"; var githubtext = "this indexer"; + var githubtemplate = "?template=bug_report.yml&" if (data.responseJSON.error.includes("check FlareSolverr logs") || data.responseJSON.error.includes("cookies provided by FlareSolverr are not valid")) { githubrepo = "FlareSolverr/FlareSolverr"; githubtext = "FlareSolverr"; + githubtemplate = "?" } - doNotify("An error occurred while configuring this indexer
" + data.responseJSON.error.substring(0, indexEnd) + "
Click here to open an issue on GitHub for " + githubtext + ".", "danger", "glyphicon glyphicon-alert", false); + doNotify("An error occurred while configuring this indexer
" + data.responseJSON.error.substring(0, indexEnd) + "
Click here to open an issue on GitHub for " + githubtext + ".", "danger", "glyphicon glyphicon-alert", false); } else { doNotify("An error occurred while configuring this indexer, is Jackett server running ?", "danger", "glyphicon glyphicon-alert"); } @@ -714,14 +716,16 @@ function testIndexer(id, notifyResult) { }).fail(function (data) { updateTestState(id, "error", data.error, indexers); if (data.responseJSON.error !== undefined && notifyResult) { - var indexEnd = 2048 - "https://github.com/Jackett/Jackett/issues/new?title=[".length - id.length - "] ".length - " (Test)".length; // keep url <= 2k #5104 + var indexEnd = 2048 - "https://github.com/Jackett/Jackett/issues/new?template=bug_report.yml&title=[".length - id.length - "] ".length - " (Test)".length; // keep url <= 2k #5104 var githubrepo = "Jackett/Jackett"; var githubtext = "this indexer"; + var githubtemplate = "?template=bug_report.yml&" if (data.responseJSON.error.includes("check FlareSolverr logs") || data.responseJSON.error.includes("cookies provided by FlareSolverr are not valid")) { githubrepo = "FlareSolverr/FlareSolverr"; githubtext = "FlareSolverr"; + githubtemplate = "?" } - doNotify("An error occurred while testing this indexer
" + data.responseJSON.error.substring(0, indexEnd) + "
Click here to open an issue on GitHub for " + githubtext + ".", "danger", "glyphicon glyphicon-alert", false); + doNotify("An error occurred while testing this indexer
" + data.responseJSON.error.substring(0, indexEnd) + "
Click here to open an issue on GitHub for " + githubtext + ".", "danger", "glyphicon glyphicon-alert", false); } else { doNotify("An error occurred while testing indexers, please take a look at indexers with failed test for more informations.", "danger", "glyphicon glyphicon-alert"); } @@ -887,8 +891,8 @@ function populateSetupForm(indexerId, name, config, caps, link, alternativesitel } }).fail(function (data) { if (data.responseJSON.error !== undefined) { - var indexEnd = 2048 - "https://github.com/Jackett/Jackett/issues/new?title=[".length - indexerId.length - "] ".length - " (Config)".length; // keep url <= 2k #5104 - doNotify("An error occurred while updating this indexer
" + data.responseJSON.error.substring(0, indexEnd) + "
Click here to open an issue on GitHub for this indexer.", "danger", "glyphicon glyphicon-alert", false); + var indexEnd = 2048 - "https://github.com/Jackett/Jackett/issues/new?template=bug_report.yml&title=[".length - indexerId.length - "] ".length - " (Config)".length; // keep url <= 2k #5104 + doNotify("An error occurred while updating this indexer
" + data.responseJSON.error.substring(0, indexEnd) + "
Click here to open an issue on GitHub for this indexer.", "danger", "glyphicon glyphicon-alert", false); } else { doNotify("An error occurred while updating this indexer, request to Jackett server failed, is server running ?", "danger", "glyphicon glyphicon-alert"); } diff --git a/src/Jackett.Common/Content/index.html b/src/Jackett.Common/Content/index.html index a6b155874..25619ce6d 100644 --- a/src/Jackett.Common/Content/index.html +++ b/src/Jackett.Common/Content/index.html @@ -732,6 +732,6 @@ - +