Add feature request template

This commit is contained in:
KennyTV 2021-03-22 15:30:33 +01:00
parent 2f45de2f6a
commit 00b4c9b1f8
No known key found for this signature in database
GPG Key ID: 6BE3B555EBC5982B
3 changed files with 60 additions and 15 deletions

View File

@ -1,4 +1,4 @@
name: Bug report name: Bug Report
description: Report a bug or console error description: Report a bug or console error
body: body:
@ -8,29 +8,34 @@ body:
- type: input - type: input
attributes: attributes:
label: "'/viaversion dump' output" label: "'/viaversion dump' Output"
description: Run `/viaversion dump` in the console or in the chat, then copy and paste the given link here. description: |
Run `/viaversion dump` in the console or in the chat, then copy and paste the given link here.
placeholder: |
https://dump.viaversion.com/...
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Console error label: Console Error
description: | description: |
If you encounter warnings/errors in your console, **paste them under https://paste.gg/** and put the paste link here. If you encounter warnings/errors in your console, **paste them with https://paste.gg/ and put the paste link here**.
If the error is small/less than 10 lines, you may put it directly into this field. If the error is small/less than 10 lines, you may put it directly into this field.
value: | value: |
``` ```
Put the paste.gg link or text here. Put the paste.gg link or text here.
``` ```
placeholder: Please do not remove the grave accents; simply replace the line of text in the middle.
validations: validations:
required: false required: false
- type: textarea - type: textarea
attributes: attributes:
label: Bug description label: Bug Description
description: | description: |
A clear and concise description of what the bug is. Describe the unexpected behavior.
If you want to attach screenshots, use the comment field at the bottom of the page.
placeholder: | placeholder: |
Example: "Placing signs on 1.13.2 causes text to disappear." Example: "Placing signs on 1.13.2 causes text to disappear."
validations: validations:
@ -38,9 +43,9 @@ body:
- type: textarea - type: textarea
attributes: attributes:
label: Steps to reproduce label: Steps to Reproduce
description: | description: |
A clear and concise description of how we can reproduce the issue. List the steps on how we can reproduce the issue. Make sure we can easily understand what you mean with each step.
placeholder: | placeholder: |
Example: Example:
1. Login with a 1.13.2 client 1. Login with a 1.13.2 client
@ -51,9 +56,9 @@ body:
- type: textarea - type: textarea
attributes: attributes:
label: Expected behavior label: Expected Behavior
description: | description: |
A clear and concise description of what you expected to happen. Describe what exactly you expected to happen.
placeholder: | placeholder: |
Example: "Placed sign text should not disappear." Example: "Placed sign text should not disappear."
validations: validations:
@ -61,7 +66,7 @@ body:
- type: textarea - type: textarea
attributes: attributes:
label: Additional server information label: Additional Server Info
description: | description: |
Do you use a proxy (eg. BungeeCord)? What software do you use and what plugins? Do you use a proxy (eg. BungeeCord)? What software do you use and what plugins?
placeholder: | placeholder: |
@ -74,11 +79,11 @@ body:
label: Checklist label: Checklist
description: Make sure you have followed each of the steps outlined here. description: Make sure you have followed each of the steps outlined here.
options: options:
- label: Via plugins are only running on **either** the backend servers (e.g. Paper) **or** the proxy (e.g. BungeeCord), **not on both**. - label: Via plugins are only running on **EITHER** the backend servers (e.g. Paper) **OR** the proxy (e.g. BungeeCord), **not on both**.
required: true required: true
- label: I have included a ViaVersion dump. - label: I have included a ViaVersion dump.
required: true required: true
- label: If applicable, I have included a paste (not a screenshot) of the error. - label: If applicable, I have included a paste (**not a screenshot**) of the error.
required: true required: true
- label: I have tried a build from https://ci.viaversion.com/ and the issue still persists. - label: I have tried a build from https://ci.viaversion.com/ and the issue still persists.
required: true required: true
@ -86,5 +91,5 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
## Comments And Screenshots
If needed, add **screenshots to help explain your problem** in the comment field below. If needed, add **screenshots to help explain your problem** in the comment field below.

View File

@ -1,5 +1,8 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Dev builds
url: https://ci.viaversion.com/
about: Before reporting a bug, please check if using master/dev builds from our ci fixes your issue.
- name: ViaVersion Discord - name: ViaVersion Discord
url: https://discord.gg/viaversion url: https://discord.gg/viaversion
about: For smaller issues or questions, you can also join our Discord server. about: For smaller issues or questions, you can also join our Discord server.

View File

@ -0,0 +1,37 @@
name: Feature Request
description: Suggest a feature to be added
body:
- type: textarea
attributes:
label: Problem Description
description: |
Describe the issue you are facing or why you need the feature to be added.
placeholder: |
I am always frustrated with...
validations:
required: true
- type: textarea
attributes:
label: Solution Description
description: |
Describe the solution you would like to see.
validations:
required: true
- type: textarea
attributes:
label: Alternatives
description: |
Describe alternatives you have considered.
validations:
required: false
- type: textarea
attributes:
label: Additional Info
description: |
Does the feature apply to any specific version or environment?
validations:
required: false