From 78f76c8343126bdeb5c00b9f4f938570ad07301c Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 8 Mar 2021 17:51:42 +0100 Subject: [PATCH] improve feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.yml | 43 +++++++++++----------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index b733156..0659b7c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,24 +1,23 @@ ---- name: Feature Request description: Suggest a new Feature for PlaceholderAPI labels: 'Type: Enhancement' +issue_body: false body: - type: markdown attributes: value: |- - Thank you for opening a Feature request. - Please make sure you first checked for any existing issue (either open or closed), Discussion or Pull request about your suggestion. - If it doesn't exist, proceed. + Thank you for taking the time in creating this Feature Request. + In order to process your feature request as fast and efficiently as possible do we ask you to fill out any required fields (Indicated with a red asterisk (`*`)) with the requested information. - Note that any suggestions towards a specific Expansion should be made on that expansion's repository and not here! + If you have any further questions should you either [join our Discord Server](https://helpch.at/discord) or [ask in our Discussions](https://github.com/PlaceholderAPI/PlaceholderAPI/discussions). - type: checkboxes attributes: label: Confirmation description: Please make sure to have followed the following checks. options: - - label: I checked the Issue tracker and any Open PRs for my idea. + - label: I checked the Issues and Pull request tab for any existing issues or PRs. required: true - - label: My idea is for **PlaceholderAPI** and not any expansion or other plugin. + - label: My Feature Request is for **PlaceholderAPI** and not any expansion or other plugin. required: true - type: dropdown attributes: @@ -26,35 +25,37 @@ body: description: "What type is your Suggestion? Select all that match." multiple: true options: - - New API feature - - New config option - - Minor Code improvement (Won't affect Servers) - - Major Code improvement (Will affect Servers) + - "New API feature" + - "New config option" + - "Minor Code improvement (Won't affect Servers)" + - "Major Code improvement (Will affect Servers)" validations: required: true - type: textarea attributes: label: "Description" description: |- - Give a detailed explanation about your suggestion and why it would be beneficial for PlaceholderAPI. - Just saying "It's cool!" or "I need it" aren't valid reasons, as it should also benefit other users and not just you. + Give a detailed explanation about your Feature request and why it would be beneficial for PlaceholderAPI. + Just saying "It's cool!" or "I need it" don't count as valid reasons. It needs to have a clear benefit for **other** players too. validations: required: true - type: textarea attributes: label: "Code Example" - description: "Do you have any Code Examples that you could show us?" - validations: - required: false + description: |- + Do you have any Code Snippets that you want to share with us? + Remember to use Code blocks for smaller snippets and https://paste.helpch.at for larger ones. - type: input attributes: label: "Jar file" - description: "If you already have a Jar file with those suggested features, provide it as download link here. Set 'N/A' if you don't have a jar file available." + description: |- + If you already have a PlaceholderAPI Jar with the requested changes would we love to get a download link for it. + If you don't have a download link can you leave this field empty or provide "N/A" as a response. placeholder: "https://cdn.discordapp.com/..." - validations: - required: true -- type: markdown +- type: textarea attributes: - value: |- + label: "Additional Information" + description: |- Add any extra info you think is nessesary for this Feature request. - When you selected `Major Code improvement (Will affect Servers)` should you mention what will break when people update. + placeholder: "Put any extra info you like into this field..."