aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuck <git@lucko.me>2023-08-28 17:30:42 +0100
committerLuck <git@lucko.me>2023-08-28 17:30:47 +0100
commit4729100d4993294bcecbd6b0b4b509ff9a9513e7 (patch)
tree7128cd076c1200b9ebe98c632bd8b187d878c3f2
parentb443924a665574f21e05e115eafea6171b046a02 (diff)
downloadspark-4729100d4993294bcecbd6b0b4b509ff9a9513e7.tar.gz
spark-4729100d4993294bcecbd6b0b4b509ff9a9513e7.tar.bz2
spark-4729100d4993294bcecbd6b0b4b509ff9a9513e7.zip
Add issue templates
-rw-r--r--.github/ISSUE_TEMPLATE/bug.yml91
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/suggestion.yml37
3 files changed, 133 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
new file mode 100644
index 0000000..0a13df4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,91 @@
+name: 🐛 ​ Bug report
+description: Report an issue or problem.
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Hello! Thanks for reporting a bug to the spark team.
+
+ Before going any further, please check to see if your bug has already been:
+
+ * fixed (check the [changelog](https://spark.lucko.me/changelog))
+ * reported by someone else (check the [open issues](https://github.com/lucko/spark/issues))
+
+ Please also consider raising the issue in our [Discord](https://discord.gg/PAGT2fu) before reporting it here. (more often you can get help faster there!)
+
+ Thanks! :)
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: Please provide a short description of the issue in the space below.
+ placeholder: Description goes here!
+ validations:
+ required: true
+ - type: textarea
+ id: reproduction-steps
+ attributes:
+ label: Reproduction Steps
+ description: Please provide a clear list of steps we should follow in order to reproduce your issue in the space below.
+ placeholder: List reproduction steps here, please!
+ validations:
+ required: true
+ - type: textarea
+ id: expected-behaviour
+ attributes:
+ label: Expected Behaviour
+ description: Please provide a description of what you expected to happen.
+ placeholder: Describe what you expected to happen here.
+ validations:
+ required: true
+ - type: textarea
+ id: platform-version
+ attributes:
+ label: Platform Information
+ description: |
+ Please provide details about the platform that spark is running on.
+
+ This *must* include the versions of all relevant components.
+
+ * Minecraft Version - e.g. "Minecraft 1.19.4"
+ * Platform Type - e.g. "server", "client" or "proxy"
+ * Platform Brand - e.g. "Forge", "Fabric", "Paper"
+ * Platform Version - e.g. "Forge 47.1.44", "Paper git-Paper-124"
+ value: |
+ * Minecraft Version:
+ * Platform Type:
+ * Platform Brand:
+ * Platform Version:
+ validations:
+ required: true
+ - type: input
+ id: spark-version
+ attributes:
+ label: Spark Version
+ description: Please provide the exact version number of spark you are using.
+ placeholder: v1.10.50
+ validations:
+ required: true
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs and Configs
+ description: If you think it would be helpful, please also include a pastebin of any relevant config files or log output. You should use https://gist.github.com/ to upload, then include the link below.
+ placeholder: https://gist.github.com/HelpfulBugReporter/ThisIsAVeryUsefulLogOutput
+ validations:
+ required: false
+ - type: textarea
+ id: extra-info
+ attributes:
+ label: Extra Details
+ description: Please include any other relevant details in the space below.
+ placeholder: I was able to reproduce this only at the end of a rainbow.
+ validations:
+ required: false
+ - type: markdown
+ attributes:
+ value: |
+ Please fill in the fields above with as much detail as possible before submitting. :)
+
+ Thanks!
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..6a6c4aa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: 💬 ​ Ask a question
+ url: https://discord.gg/PAGT2fu
+ about: We use Discord to provide support for the project. If you have a question, need help, or aren't sure if you've found a bug or not, please come and talk to us there!
diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml
new file mode 100644
index 0000000..f36b870
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggestion.yml
@@ -0,0 +1,37 @@
+name: 💡 ​ Suggestion
+description: Suggest an idea for an improvement or change.
+labels: ["suggestion"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Before going any further, please check to see if your suggestion has already been:
+
+ * implemented (check the [docs](https://spark.lucko.me/docs))
+ * proposed by someone else (check the [open issues](https://github.com/lucko/spark/issues))
+
+ Thanks!
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: Please provide a short description of your suggestion in the space below.
+ placeholder: Hello, perhaps you should...
+ validations:
+ required: true
+ - type: textarea
+ id: proposed-behaviour
+ attributes:
+ label: Proposed Behaviour
+ description: Please provide a short explanation of how the feature should work / be changed, and how this will affect the project.
+ placeholder: It would...
+ validations:
+ required: true
+ - type: textarea
+ id: extra-info
+ attributes:
+ label: Extra Details
+ description: Please include any other relevant details in the space below.
+ placeholder: I think this should only function at the end of a rainbow.
+ validations:
+ required: false \ No newline at end of file