summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml65
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/rfc.yml68
-rw-r--r--.github/ISSUE_TEMPLATE/suggestion.yml38
4 files changed, 176 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..3c147eb94b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,65 @@
+name: Bug Report
+description: File a bug report
+labels: [bug, needs-triage]
+body:
+- type: markdown
+ attributes:
+ value: |
+ If you need help with running Minecraft, please visit us [on our Discord](https://discord.gg/meshmc) before making a bug report.
+
+ Before submitting a bug report, please make sure you have read this *entire* form, and that:
+ * You have read the [FAQ](https://github.com/Project-Tick/MeshMC/wiki/FAQ) and it has not answered your question
+ * Your bug is not caused by Minecraft or any mods you have installed.
+ * Your issue has not been reported before, [make sure to use the search function!](https://github.com/Project-Tick/MeshMC/issues)
+
+ **Do not forget to give your issue a descriptive title.** "Bug in the instance screen" makes it hard to distinguish issues at a glance.
+- type: dropdown
+ attributes:
+ label: Operating System
+ description: If you know this bug occurs on multiple operating systems, select all you have tested.
+ multiple: true
+ options:
+ - Windows
+ - macOS
+ - Linux
+ - Other
+- type: textarea
+ attributes:
+ label: Version of MeshMC
+ description: The version of MeshMC used in the bug report.
+ placeholder: MeshMC 7.0.0
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Version of Qt
+ description: The version of Qt used in the bug report. You can find it in Help -> About MeshMC -> About Qt.
+ placeholder: Qt 6.3.0
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Description of bug
+ description: What did you expect to happen, what happened, and why is it incorrect?
+ placeholder: The cat button should show a cat, but it showed a dog instead!
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Steps to reproduce
+ description: A bulleted list, or an exported instance if relevant.
+ placeholder: "* Press the cat button"
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Suspected cause
+ description: If you know what could be causing this bug, describe it here.
+ validations:
+ required: false
+- type: checkboxes
+ attributes:
+ label: This issue is unique
+ options:
+ - label: I have searched the issue tracker and did not find an issue describing my bug.
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..37c7e6ebdc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: MeshMC Discord
+ url: https://discord.gg/meshmc
+ about: Please ask for support here before opening an issue.
diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml
new file mode 100644
index 0000000000..d9f5b0a981
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/rfc.yml
@@ -0,0 +1,68 @@
+# Template based on https://gitlab.archlinux.org/archlinux/rfcs/-/blob/0ba3b61e987e197f8d1901709409b8564958f78a/rfcs/0000-template.rst
+name: Request for Comment (RFC)
+description: Propose a larger change and start a discussion.
+labels: ["type: enhancement", "status: needs discussion", "status: needs triage"]
+body:
+- type: markdown
+ attributes:
+ value: |
+ ### Use this form to suggest a larger change for MeshMC.
+- type: textarea
+ attributes:
+ label: Goal
+ description: Short description, 1-2 sentences.
+ placeholder: Remove the cat from the launcher.
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Motivation
+ description: |
+ Introduce the topic. If this is a not-well-known section of MeshMC, a detailed explanation of the background is recommended.
+ Some example points of discussion:
+ - What specific problems are you facing right now that you're trying to address?
+ - Are there any previous discussions? Link to them and summarize them (don't force your readers to read them though!).
+ - Is there any precedent set by other software? If so, link to resources.
+ placeholder: I don't like cats. I think many users also don't like cats.
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Specification
+ description: A concrete, thorough explanation of what is being planned.
+ placeholder: Remove the cat button and all references to the cat from the codebase. Including resource files.
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Drawbacks
+ description: Carefully consider every possible objection and issue with your proposal. This section should be updated as feedback comes in from discussion.
+ placeholder: Some users might like cats.
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Unresolved Questions
+ description: |
+ Are there any portions of your proposal which need to be discussed with the community before the RFC can proceed?
+ Be careful here -- an RFC with a lot of remaining questions is likely to be stalled.
+ If your RFC is mostly unresolved questions and not too much substance, it may not be ready.
+ placeholder: Do a lot of users care about the cat?
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Alternatives Considered
+ description: A list of alternatives, that have been considered and offer equal or similar features to the proposed change.
+ placeholder: Maybe the cat could be replaced with an axolotl?
+ validations:
+ required: true
+- type: checkboxes
+ attributes:
+ label: This suggestion is unique
+ options:
+ - label: I have searched the issue tracker and did not find an issue describing my suggestion, especially not one that has been rejected.
+ required: true
+- type: textarea
+ attributes:
+ label: You may use the editor below to elaborate further.
diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml
new file mode 100644
index 0000000000..53bd186531
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggestion.yml
@@ -0,0 +1,38 @@
+name: Suggestion
+description: Make a suggestion
+labels: [idea, needs-triage]
+body:
+- type: markdown
+ attributes:
+ value: |
+ ### Use this form to suggest a feature for MeshMC.
+- type: input
+ attributes:
+ label: Role
+ description: In what way do you use MeshMC that needs this feature?
+ placeholder: I play modded Minecraft.
+ validations:
+ required: true
+- type: input
+ attributes:
+ label: Suggestion
+ description: What do you want MeshMC to do?
+ placeholder: I want the cat button to meow.
+ validations:
+ required: true
+- type: input
+ attributes:
+ label: Benefit
+ description: Why do you need MeshMC to do this?
+ placeholder: so that I can always hear a cat when I need to.
+ validations:
+ required: true
+- type: checkboxes
+ attributes:
+ label: This suggestion is unique
+ options:
+ - label: I have searched the issue tracker and did not find an issue describing my suggestion, especially not one that has been rejected.
+ required: true
+- type: textarea
+ attributes:
+ label: You may use the editor below to elaborate further.