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"