From 33e4743e89cf4e229939b79c55094f673a49e8c3 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 8 Mar 2021 17:36:34 +0100 Subject: [PATCH 1/3] Use description in favour of about --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 976a6b8..b733156 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ --- name: Feature Request -about: Suggest a new Feature for PlaceholderAPI +description: Suggest a new Feature for PlaceholderAPI labels: 'Type: Enhancement' body: - type: markdown 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 2/3] 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..." From 375e743124d37d1ed29f2387670dbae964f04ee2 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 8 Mar 2021 18:06:10 +0100 Subject: [PATCH 3/3] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 43 +++++++++++++++------------ 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f8c65b9..91ce97e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -5,11 +5,11 @@ body: - type: markdown attributes: value: |- - Thank you for opening a bug report. In order to process the Report efficiently and to also help you with it in the process do we require some specific information from you. - Please make sure to always use the latest Release on Spigot, or the latest Development release from our Jenkins Server. + Thank you for taking your time and opening a Bug Report. + In order for us to process this Bug Report as fast and efficient as possible do we ask you to read the form carefully and provide any requested information. + Required fields are marked with an asterisk symbol (`*`) - Spigot: https://www.spigotmc.org/resources/6245/ - Jenkins: http://ci.extendedclip.com/job/PlaceholderAPI/ + Also, always make sure to use the latest Release from [Spigot](https://www.spigotmc.org/resources/6245/) or the latest Development Build from our [Jenkins Server](http://ci.extendedclip.com/job/PlaceholderAPI/) to make sure that your issue isn't already fixed. **DO NOT REPORT ISSUES WITH EXPANSIONS AND/OR PLACEHOLDERS. USE THE APPROPRIATE ISSUE TRACKER FOR THOSE!** - type: checkboxes @@ -21,33 +21,36 @@ body: required: true - label: My issue is about **PlaceholderAPI** and not any expansion or external plugin required: true + - label: The issue isn't already fixed in a Spigot Release or Development Build. + required: true - type: dropdown attributes: label: "Type" - description: "What type of bug do you encounter?" + description: |- + What kind of Bug do you encounter? + + - `Plugin Bug`: PlaceholderAPI doesn't startup properly. + - `API Bug`: A method you use didn't work or has an unexpected result. + - `Plugin/Server Incompatability`: PlaceholderAPI either doesn't support a specific Server Type/Version or has conflicts with another plugin. multiple: false options: - - Plugin Bug - - API Bug - - Plugin/Server Incompatability + - "Plugin Bug" + - "API Bug" + - "Plugin/Server Incompatability" validations: required: true - type: textarea attributes: label: "What happens?" description: "What bug are you encountering? Try to explain it as detailed as possible." + placeholder: "PlaceholderAPI does this when I do that..." validations: required: true - type: textarea attributes: label: "Expected Behaviour" description: "What behaviour did you expect from PlaceholderAPI?" - validations: - required: true -- type: textarea - attributes: - label: "Actual Behaviour" - description: "How does PlaceholderAPI behave instead?" + placeholder: "PlaceholderAPI should actually do..." validations: required: true - type: textarea @@ -55,7 +58,7 @@ body: label: "How to Reproduce" description: |- List the steps on how to reproduce this Bug. - Post any Code-examples in the `Additional Info` field below when you selected `API Bug`. + Post any Code-examples in the `Additional Information` field below when you selected `API Bug`. placeholder: |- 1. Do this 2. ... @@ -65,17 +68,19 @@ body: - type: input attributes: label: "`/papi dump` Output" - description: "Paste the output of `/papi dump` in the field below. It includes a lot of useful information for us." + description: |- + Please execute the `/papi dump` command and provide the generated URL from it. + If you can't execute the command (i.e. PlaceholderAPI doesn't start up) can you put N/A here and mention the issue in the `Additional Information` field. placeholder: "https://paste.helpch.at/dump.log" validations: required: true - type: input attributes: label: "Errors" - description: "Post links to any Stacktraces or Errors PlaceholderAPI printed. We recommend using https://paste.helpch.at, https://paste.gg or any other hastebin/Pastebin-like site." + description: |- + Please share any exceptions, errors and stack traces that PlaceholderAPI may print in the console. + For smaller errors can you use code blocks but it's recommended to use either https://paste.helpch.at, https://paste.gg or another hastebin/pastebin site for larger errors. placeholder: "https://paste.helpch.at/error.log" - validations: - required: false - type: textarea attributes: label: "Additional Info"