Merge pull request #136 from MickVermeulen/main

Add issue templates

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,51 @@
+name: Bug Report
+description: Report incorrect behavior in DarkflameServer
+title: "BUG: "
+labels: ["bug", "triage"]
+
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      options:
+        - label: >
+            I have checked that this issue has not already been reported.
+          required: true
+        - label: >
+            I have validated that this issue is not a syntax error of either MySQL or SQLite.
+          required: true
+        - label: >
+            I have pulled the latest version of the main branch of DarkflameServer and have confirmed that the issue exists there.
+          required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Issue Description
+      description: >
+        Please provide a description of the issue. If this is an in-game bug, please also include pictures that showcase the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction steps
+      description: >
+        Please provide a concise list of steps needed to reproduce this issue.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: >
+        Please describe what you expected to happen instead of the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: >
+        Please include the environment you're running DarkflameServer on (for example: Windows, macOS, Ubuntu, WSL, etc).
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/documentation_improvement.yaml

@@ -0,0 +1,42 @@
+name: Documentation Improvement
+description: Report wrong or missing documentation
+title: "DOC: "
+labels: ["docs", "triage"]
+
+body:
+  - type: checkboxes
+    attributes:
+      options:
+        - label: >
+            I have checked that this issue has not already been reported.
+          required: true
+        - label: >
+            I have validated that the documentation is wrong or missing on the latest version of the main branch of DarkflameServer
+          required: true
+  - type: textarea
+    id: location
+    attributes:
+      label: Location of the documentation
+      description: >
+        Please provide the location of the documentation, e.g. "Entity.cpp" or the
+        URL of the documentation, e.g.
+        "https://github.com/DarkflameUniverse/DarkflameServer/blob/main/README.md"
+      placeholder: https://github.com/DarkflameUniverse/DarkflameServer/blob/main/README.md
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Documentation problem
+      description: >
+        Please provide a description of what documentation you believe needs to be fixed/improved
+    validations:
+      required: true
+  - type: textarea
+    id: suggested-fix
+    attributes:
+      label: Suggested fix for documentation
+      description: >
+        Please explain the suggested fix and **why** it's better than the existing documentation
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,40 @@
+name: Feature Request
+description: Suggest an idea for DarkflameServer
+title: "ENH: "
+labels: ["enhancement", "triage"]
+
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem?
+      description: >
+        Please provide a description of what the problem is, e.g. "I wish I could use DarkflameServer to do [...]"
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: >
+        Please provide a description of the feature request, e.g. "`SlashCommandHandler.cpp` should get a new command `/unlimited-coins` that [...]", try to write a docstring for the desired feature
+    validations:
+      required: true
+  - type: textarea
+    id: implications
+    attributes:
+      label: Repository breaking implications
+      description: >
+        Please provide a description of how this feature will affect the DarkflameServer repository
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: >
+        Please provide a description of any alternative solutions or features you've considered
+  - type: textarea
+    id: example
+    attributes:
+      label: Additional context
+      description: >
+        Please add any other context, code examples, or references to existing implementations about the feature request here

.github/ISSUE_TEMPLATE/installation_issue.yaml

@@ -0,0 +1,53 @@
+name: Installation Issue
+description: Report issues installing the DarkflameServer on your system
+title: "BUILD: "
+labels: ["build", "triage"]
+
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      options:
+        - label: >
+            I have read the [installation guide](https://github.com/DarkflameUniverse/DarkflameServer/blob/main/README.md).
+          required: true
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: >
+        Please provide on which platform you've tried to install DarkflameServer
+      options:
+        - Windows
+        - WSL1
+        - WSL2
+        - macOS
+        - Ubuntu
+        - Other
+    validations:
+      required: true
+  - type: dropdown
+    id: architecture
+    attributes:
+      label: Architecture
+      description: >
+        Please provide on which architecture you've tried to install DarkflameServer
+      options:
+        - x86
+        - ARM
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error Logs
+      description: >
+        If possible, please copy and paste the error logs when attempting to install DarkflameServer.
+      value: >
+        <details>
+
+
+        Replace this line with the error logs.
+
+
+        </details>

.github/ISSUE_TEMPLATE/performance_issue.yaml

@@ -0,0 +1,33 @@
+name: Performance Issue
+description: Report slow performance or memory issues when running DarkflameServer
+title: "PERF: "
+labels: ["performance", "triage"]
+
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      options:
+        - label: >
+            I have checked that this issue has not already been reported.
+          required: true
+        - label: >
+            I have pulled the latest version of the main branch of DarkflameServer and have confirmed that the issue exists there.
+          required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: Reproducible Example
+      description: >
+        Please provide a minimal, example that quantifies slow runtime or memory issues. 
+        Ideally include screenshots of CPU usage or memory usage. And if possible point
+        to the code that you may suspect to cause the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: prior-performance
+    attributes:
+      label: Prior Performance
+      description: >
+        If applicable, please provide the prior version of DarkflameServer and output
+        of the same reproducible example where the performance issue did not exist.