Migrate to issue forms for GitHub

This commit is contained in:
filoghost 2021-06-23 13:04:13 +02:00
parent c2808811a9
commit 8c01c20c42
9 changed files with 141 additions and 137 deletions

View File

@ -1,36 +0,0 @@
---
name: 🐞 Bug report
about: Report a bug or some unexpected behavior.
labels: Bug
---
<!--
⚠️ READ BELOW BEFORE SUBMITTING ⚠️
Before opening a bug report:
* Read the FAQ: https://filoghost.me/docs/chest-commands/faq
* Try the latest development build: https://ci.codemc.io/job/filoghost/job/ChestCommands
* Make sure the bug hasn't already been reported (you can add comments to the existing issue)
Don't paste long text files in the description, upload them as attachments or on Pastebin.
You MUST fill out the template below, without modifying or deleting the existing text, otherwise the issue will be automatically closed.
-->
### Description
<!-- Write a clear and concise description of the bug -->
### How to reproduce
<!-- A list of steps to reproduce the bug -->
### Platform
<!-- Fill in the list below -->
- Server version (output of `/version`):
- Chest Commands version (check with `/cc`):
### Additional context
<!-- Screenshots, errors, configurations (if relevant) -->

67
.github/ISSUE_TEMPLATE/1-bug.yml vendored Normal file
View File

@ -0,0 +1,67 @@
name: 🐞 Bug Report
description: "Report a bug or some unexpected behavior."
labels:
- "Bug"
body:
- type: markdown
attributes:
value: |-
Please fill this form carefully and provide the requested details. Thank you for contributing to the project.
- type: checkboxes
attributes:
label: "Confirmation"
description: "Please confirm to have done the following checks before opening a new issue."
options:
- label: "I have read the [FAQ](https://filoghost.me/docs/chest-commands/faq)."
required: true
- label: "I have tested the [latest development build](https://ci.codemc.io/job/filoghost/job/ChestCommands) of Chest Commands and the bug is still present."
required: true
- label: "I have updated **Spigot** to the latest release for my particular Minecraft version."
required: true
- label: "I made sure the bug hasn't already been reported on the [issue tracker](https://github.com/filoghost/ChestCommands/issues?q=is%3Aissue)."
required: true
- type: textarea
attributes:
label: "Description"
description: |-
Clear and concise description of the bug.
<ins>**Avoid long error logs**</ins>, add them in the "Addition information" area at the bottom of this form.
placeholder: "What happened? What did you expect to happen instead?"
validations:
required: true
- type: textarea
attributes:
label: "How to reproduce"
description: "List of steps to reproduce the bug."
placeholder: |-
1.
2.
3.
validations:
required: true
- type: input
attributes:
label: "Server version"
description: "Output of the command `/version`."
placeholder: "This server is running CraftBukkit version 3132-Spigot-66f9d3c-40caacc (MC: 1.17) (Implementing API version 1.17-R0.1-SNAPSHOT)"
validations:
required: true
- type: input
attributes:
label: "Chest Commands version"
description: "Output of the command `/version ChestCommands`."
placeholder: "ChestCommands version 4.0.4-SNAPSHOT-b75"
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: |-
Relevant attachments such as **screenshots**, **server logs**, **configurations files** or any other additional information that might be useful.
Text files can also be uploaded to [Pastebin](https://pastebin.com) and shared through the generated link.

View File

@ -1,17 +0,0 @@
---
name: 💡 Suggestion
about: "Suggest a new feature or an improvement. ⚠ Note: suggestions have low priority, I will answer them only if possible."
labels: Enhancement
---
<!--
⚠️ READ BELOW BEFORE SUBMITTING ⚠️
Please only suggest changes that would benefit many users, not just a specific situation.
You MUST fill out the template below, without modifying or deleting the existing text, otherwise the issue will be automatically closed.
-->
### Description
<!-- Describe the new feature or the improvement you would like to see -->

16
.github/ISSUE_TEMPLATE/2-feature.yml vendored Normal file
View File

@ -0,0 +1,16 @@
name: 💡 Suggestion
description: "Suggest a new feature or an improvement."
labels:
- "Enhancement"
body:
- type: markdown
attributes:
value: |-
Please suggest changes that would benefit as many users as possible, not just specific situations. Thank you for contributing to the project.
- type: textarea
attributes:
label: "Description"
description: "Describe the new feature or improvement."
validations:
required: true

View File

@ -1,36 +0,0 @@
---
name: 📝 Help request
about: "Ask a question about the plugin. ⚠ Note: help requests have low priority, I will answer them only if possible."
labels: Help
---
<!--
⚠️ READ BELOW BEFORE SUBMITTING ⚠️
Before asking for help:
* Read the documentation: https://filoghost.me/docs/chest-commands
* Read the FAQ: https://filoghost.me/docs/chest-commands/faq
* Update the plugin: https://dev.bukkit.org/projects/chest-commands
Don't paste long text files in the description, upload them as attachments or on Pastebin.
You MUST fill out the template below, without modifying or deleting the existing text, otherwise the issue will be automatically closed.
-->
### What are you trying to do?
<!-- Describe the goal you want to achieve -->
### What have you tried so far?
<!-- If you already tried something, please elaborate -->
### Platform
<!-- Fill in the list below -->
- Server version (output of `/version`):
- Chest Commands version (check with `/cc`):
### Additional context
<!-- Screenshots, errors, configurations (if relevant) -->

42
.github/ISSUE_TEMPLATE/3-help.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: 📝 Help request
description: "Ask a question."
labels:
- "Help"
body:
- type: markdown
attributes:
value: |-
Please make sure you are using a recent version of the plugin.
- type: checkboxes
attributes:
label: "Confirmation"
description: "Please confirm to have done the following checks before opening a new issue."
options:
- label: "I have read the [documentation](https://filoghost.me/docs/chest-commands)."
required: true
- label: "I have read the [FAQ](https://filoghost.me/docs/chest-commands/faq)."
required: true
- type: textarea
attributes:
label: "Description"
description: "Describe your goal and what you have tried so far."
placeholder: "What are you trying to achieve? What have you tried so far?"
validations:
required: true
- type: input
attributes:
label: "Chest Commands version"
description: "Output of the command `/version ChestCommands`."
placeholder: "ChestCommands version 4.0.4-SNAPSHOT-b75"
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: |-
Relevant attachments such as **screenshots**, **server logs**, **configurations files** or any other additional information that might be useful.
Text files can also be uploaded to [Pastebin](https://pastebin.com) and shared through the generated link.

View File

@ -1,15 +0,0 @@
---
name: 📚 Documentation improvement
about: "Request an improvement for the official documention."
labels: Documentation
---
<!--
⚠️ READ BELOW BEFORE SUBMITTING ⚠️
You MUST fill out the template below, without modifying or deleting the existing text, otherwise the issue will be automatically closed.
-->
### Description
<!-- Describe what should be improved (and if possible, how) -->

View File

@ -0,0 +1,16 @@
name: 📚 Documentation improvement
description: "Suggest a change or report an error to improve the official documentation."
labels:
- "Documentation"
body:
- type: markdown
attributes:
value: |-
Suggest a change or report an error to improve the official documentation. Thank you for contributing to the project.
- type: textarea
attributes:
label: "Description"
description: "Describe what should be improved and, if possible, _how_."
validations:
required: true

View File

@ -1,33 +0,0 @@
comment: >-
This issue has been automatically closed because it doesn't follow the issue template.
Please open a new issue and make sure to **follow the provided template**,
fill out the sections **without modifying** or **deleting** the existing text.
Templates are necessary to manage the project efficiently,
as basic questions don't need to be asked again each time.
issueConfigs:
# Bug
- content:
- "# Description"
- "# How to reproduce"
- "# Platform"
# Feature / Documentation
- content:
- "# Description"
# Help
- content:
- "# What are you trying to do"
- "# What have you tried so far"
- "# Platform"
caseInsensitive: true
label: "Closed by bot"
exception:
- "filoghost"