improve feature_request.md

This commit is contained in:
Andre_601 2021-03-08 17:51:42 +01:00 committed by GitHub
parent 33e4743e89
commit 78f76c8343
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,24 +1,23 @@
---
name: Feature Request name: Feature Request
description: Suggest a new Feature for PlaceholderAPI description: Suggest a new Feature for PlaceholderAPI
labels: 'Type: Enhancement' labels: 'Type: Enhancement'
issue_body: false
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: |- value: |-
Thank you for opening a Feature request. Thank you for taking the time in creating this Feature Request.
Please make sure you first checked for any existing issue (either open or closed), Discussion or Pull request about your suggestion. 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.
If it doesn't exist, proceed.
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 - type: checkboxes
attributes: attributes:
label: Confirmation label: Confirmation
description: Please make sure to have followed the following checks. description: Please make sure to have followed the following checks.
options: 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 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 required: true
- type: dropdown - type: dropdown
attributes: attributes:
@ -26,35 +25,37 @@ body:
description: "What type is your Suggestion? Select all that match." description: "What type is your Suggestion? Select all that match."
multiple: true multiple: true
options: options:
- New API feature - "New API feature"
- New config option - "New config option"
- Minor Code improvement (Won't affect Servers) - "Minor Code improvement (Won't affect Servers)"
- Major Code improvement (Will affect Servers) - "Major Code improvement (Will affect Servers)"
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: "Description" label: "Description"
description: |- description: |-
Give a detailed explanation about your suggestion and why it would be beneficial for PlaceholderAPI. 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" aren't valid reasons, as it should also benefit other users and not just you. 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: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: "Code Example" label: "Code Example"
description: "Do you have any Code Examples that you could show us?" description: |-
validations: Do you have any Code Snippets that you want to share with us?
required: false Remember to use Code blocks for smaller snippets and https://paste.helpch.at for larger ones.
- type: input - type: input
attributes: attributes:
label: "Jar file" 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/..." placeholder: "https://cdn.discordapp.com/..."
validations: - type: textarea
required: true
- type: markdown
attributes: attributes:
value: |- label: "Additional Information"
description: |-
Add any extra info you think is nessesary for this Feature request. 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. - 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..."