From 3687b29f95ea8d155b4553e946d0012df0d2b1e0 Mon Sep 17 00:00:00 2001 From: SkyanUltra Date: Sat, 22 Nov 2025 11:35:13 -0500 Subject: [PATCH] Issue page touch-up (#725) * Refine bug report template for clarity and detail Updated the bug report template to enhance clarity and detail in the descriptions and labels. * Add question issue template for Super Mario Bros. Remastered This new issue template allows users to ask questions regarding Super Mario Bros. Remastered, including checkboxes for issue types and a textarea for detailed descriptions. * Add suggestion issue template for Super Mario Bros. This template allows users to submit suggestions for Super Mario Bros. Remastered, including various types of suggestions and a description field. --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 36 ++++++++++++++--------- .github/ISSUE_TEMPLATE/02-question.yml | 31 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/03-suggestion.yml | 37 ++++++++++++++++++++++++ 3 files changed, 91 insertions(+), 13 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/02-question.yml create mode 100644 .github/ISSUE_TEMPLATE/03-suggestion.yml diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml index 8a74a2b4..9be3ed39 100644 --- a/.github/ISSUE_TEMPLATE/01-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -1,6 +1,6 @@ name: Bug Report -description: Report a bug with Super Mario Bros. Remastered -labels: ["bug"] +description: Report a bug or general issue with Super Mario Bros. Remastered +labels: ["🪲 Bug"] title: '[Bug Report]: ' body: @@ -8,21 +8,31 @@ body: id: version attributes: label: "Version" - description: "Specify the version of the game you used when you encountered the bug. You can find the game version at the bottom-left of the title screen." + description: "Specify the exact version of the game you used when you encountered the bug/issue. (You can find the game version at the bottom-left of the title screen.)" + placeholder: "1.0.2" + validations: + required: true - type: checkboxes - id: bug_type + id: type attributes: - label: "Bug Type" - description: "Select all that apply (leave blank if unsure)." + label: "Type of Issue" + description: 'Select all applicable areas of the game that are affected by this bug/issue. (Select "Miscellaneous" if unsure.)' options: - - label: campaign bug - - label: editor bug - - label: custom pack bug - - label: ui bug + - label: ROM Verification + - label: Campaign + - label: Custom Level + - label: Level Editor + - label: Default Resources + - label: Custom Resources + - label: GML Modding + - label: Inaccuracy + - label: Localization + - label: UI (User Interface) + - label: Miscellaneous validations: - required: false - + required: true + - type: textarea id: description attributes: @@ -33,7 +43,7 @@ body: id: reproduction_steps attributes: label: "Reproduction Steps" - description: "Please list the steps taken to reproduce the bug, e.g. 1. Go to ... 2. Do ..." + description: "Please list the steps taken to reproduce the bug, if applicable. (e.g. 1. Go to ... 2. Do ...)" - type: textarea id: screenshots diff --git a/.github/ISSUE_TEMPLATE/02-question.yml b/.github/ISSUE_TEMPLATE/02-question.yml new file mode 100644 index 00000000..0adac061 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-question.yml @@ -0,0 +1,31 @@ +name: Question +description: Ask a question regarding Super Mario Bros. Remastered +labels: ["❔ Question"] +title: '[Question]: ' + +body: + - type: checkboxes + id: type + attributes: + label: "Type of Issue" + description: "Please select any applicable areas of the game that are affected by this question. (Leave blank if unsure.)" + options: + - label: ROM Verification + - label: Campaign + - label: Custom Level + - label: Level Editor + - label: Default Resources + - label: Custom Resources + - label: GML Modding + - label: Inaccuracy + - label: Localization + - label: UI (User Interface) + - label: Miscellaneous + validations: + required: false + + - type: textarea + id: description + attributes: + label: "Description" + description: "Please write your question in a clear and concise manner." diff --git a/.github/ISSUE_TEMPLATE/03-suggestion.yml b/.github/ISSUE_TEMPLATE/03-suggestion.yml new file mode 100644 index 00000000..e0c7d55a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-suggestion.yml @@ -0,0 +1,37 @@ +name: Suggestion +description: Submit a suggestion for Super Mario Bros. Remastered. +labels: ["💡 Suggestion"] +title: '[Suggestion]: ' + +body: + - type: checkboxes + id: type + attributes: + label: "Type of Suggestion" + description: 'Select all applicable areas of the game that this suggestion touches on. (Select "Miscellaneous" if unsure.)' + options: + - label: ROM Verification + - label: Campaign + - label: Custom Level + - label: Level Editor + - label: Default Resources + - label: Custom Resources + - label: GML Modding + - label: Inaccuracy + - label: Localization + - label: UI (User Interface) + - label: Miscellaneous + validations: + required: true + + - type: textarea + id: description + attributes: + label: "Description" + description: "Please write a clear and concise description of the suggestion you have. Nothing too ambitious, please!" + + - type: textarea + id: screenshots + attributes: + label: "Screenshots" + description: "If applicable, add screenshots to help explain the suggestion."