From af7431be994bdbb6e0a1edbc1ec6261bc47dddd3 Mon Sep 17 00:00:00 2001
From: TechnoPorg <69441745+TechnoPorg@users.noreply.github.com>
Date: Sat, 16 Mar 2024 15:53:22 -0600
Subject: [PATCH] Add GitHub issue forms for bug reports and feature requests
(#7102)
---
.github/ISSUE_TEMPLATE/bug_report.md | 36 ---------
.github/ISSUE_TEMPLATE/bug_report.yml | 90 ++++++++++++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 18 -----
.github/ISSUE_TEMPLATE/feature_request.yml | 31 ++++++++
4 files changed, 121 insertions(+), 54 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index fcc875601..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,36 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-# Please search the issue tracker for existing bug reports before submitting your own. Delete this line to confirm no similar report has been posted yet.
-
-### Bug Summary
-
-#### Steps to reproduce
-
-#### Expected behavior
-
-#### Actual behavior
-
-#### Screenshot
-
-#### Affected LMMS versions
-
-
-
-#### Logs
-
- Click to expand
-
-
-
-
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..4cd1464d6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,90 @@
+# yamllint disable-file rule:line-length
+name: Bug Report
+description: File a bug report to help us improve
+labels:
+ - bug
+body:
+ - type: input
+ id: system-information
+ attributes:
+ label: System Information
+ description: |
+ - The operating system you use to run LMMS.
+ - When relevant, also include your hardware information.
+ placeholder: ex. Fedora Linux 39, KDE Plasma 5.27.10 - 13th Gen Intel® Core™ i9-13950HX, 32GB RAM
+ validations:
+ required: true
+ - type: input
+ id: affected-version
+ attributes:
+ label: LMMS Version(s)
+ description: |
+ - The version of LMMS affected by the bug.
+ - Can be an official version number, nightly release identifier, or commit hash.
+ - The version number can be found under the Help > About menu.
+ placeholder: ex. 1.2.2, 1.3.0-alpha.1.518+gdd53bec31, 2d185df
+ validations:
+ required: true
+ - type: input
+ id: working-version
+ attributes:
+ label: Most Recent Working Version
+ description: |
+ - If there is a previous version of LMMS that did not exhibit the bug, include it here.
+ placeholder: ex. 1.2.2, 1.3.0-alpha.1.518+gdd53bec31, 2d185df
+ validations:
+ required: false
+ - type: textarea
+ id: bug-summary
+ attributes:
+ label: Bug Summary
+ description: Briefly describe the bug.
+ validations:
+ required: true
+ - type: textarea
+ id: expected-behaviour
+ attributes:
+ label: Expected Behaviour
+ description: Describe what should have happened.
+ validations:
+ required: true
+ - type: textarea
+ id: steps-to-reproduce
+ attributes:
+ label: Steps To Reproduce
+ description: |
+ - Describe the minimum set of steps required to reproduce this bug.
+ - If you included a minimum reproducible project below, you can describe here how it should be used.
+ validations:
+ required: true
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs
+ description: |
+ - Copy and paste any relevant log output here.
+ value: |
+
+ Click to expand
+
+
+
+
+ validations:
+ required: false
+ - type: textarea
+ id: supporting-files
+ attributes:
+ label: Screenshots / Minimum Reproducible Project
+ description: |
+ - Upload any screenshots showing the bug in action.
+ - If possible, also include a .mmp/.mmpz project containing the simplest possible setup needed to reproduce the bug.
+
+ ***Note:** To upload a project file to GitHub, it will need to be placed in a .zip archive.*
+ - type: checkboxes
+ id: search-for-existing
+ attributes:
+ label: Please search the issue tracker for existing bug reports before submitting your own.
+ options:
+ - label: I have searched all existing issues and confirmed that this is not a duplicate.
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index f9a0ae192..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-# Please search the issue tracker for existing feature requests before submitting your own. Delete this line to confirm no similar request has been posted yet.
-
-### Enhancement Summary
-
-#### Justification
-
-#### Mockup
-
-
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..1f11b4eb3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,31 @@
+# yamllint disable-file rule:line-length
+name: Feature Request
+description: Suggest an idea for the project
+labels:
+ - "enhancement"
+body:
+ - type: textarea
+ id: enhancement-summary
+ attributes:
+ label: Enhancement Summary
+ description: |
+ - Briefly describe the enhancement.
+ - Explain why you believe the proposed enhancement to be a good idea, and (if applicable) how it helps overcome a limitation of LMMS you are currently facing.
+ validations:
+ required: true
+ - type: textarea
+ id: mockup
+ attributes:
+ label: Implementation Details / Mockup
+ description: |
+ - Explain how you believe this enhancement should be implemented.
+ - If your proposal encompasses changes to the user interface, include diagrams displaying your intent.
+ validations:
+ required: true
+ - type: checkboxes
+ id: search-for-existing
+ attributes:
+ label: Please search the issue tracker for existing feature requests before submitting your own.
+ options:
+ - label: I have searched all existing issues and confirmed that this is not a duplicate.
+ required: true