From 13bf408ec9b19876cb709e7c727df14c3cbec684 Mon Sep 17 00:00:00 2001 From: Dave N <13752452+HammerGS@users.noreply.github.com> Date: Sun, 8 Sep 2024 11:34:28 -0600 Subject: [PATCH] Issues templates. v1 --- .github/issue_template/bug_report.yml | 168 ++++++++++++++++++ .github/issue_template/config.yml | 14 ++ .../request_for_enhancement.yml | 97 ++++++++++ 3 files changed, 279 insertions(+) create mode 100644 .github/issue_template/config.yml create mode 100644 .github/issue_template/request_for_enhancement.yml diff --git a/.github/issue_template/bug_report.yml b/.github/issue_template/bug_report.yml index 8b1378917..d7dcbbaa4 100644 --- a/.github/issue_template/bug_report.yml +++ b/.github/issue_template/bug_report.yml @@ -1 +1,169 @@ +name: Bug Report +description: Report an issue with MegaMekLab +title: "Brief Description" +labels: [bug] +body: + - type: markdown + attributes: + value: | + **Fields marked with a red asterisk (*) are mandatory to complete.** + In this form, you’ll provide a description of the issue, steps to reproduce it, your system details, and any files that may help us resolve the problem. + - type: checkboxes + id: prerequisites-and-pre-issue-checks + attributes: + label: Prerequisites and Pre-Issue Checklist + description: Please confirm you have completed the following steps before submitting an issue. + options: + - label: | + I'm reporting the issue to the correct repository: + - [MegaMek](https://github.com/MegaMek/megamek/issues) + - [MegaMekLab](https://github.com/MegaMek/megameklab/issues) + - [MekHQ](https://github.com/MegaMek/mekhq/issues) + required: true + - label: "I've tested the issue against the latest MILESTONE version" + required: true + - label: "I've asked on the MegaMek Discord about the error" + required: true + - label: "I've reviewed the BattleTech rules and MegaMekLab documentation, and I've confirmed that something isn't working as intended." + required: true + - label: "I've searched the Github tracker and haven't found the issue listed" + required: true + + - type: markdown + attributes: + value: | + ![How to Search the GitHub Tracker](https://i.imgur.com/QMJY7pll.png) + + - type: dropdown + id: severity + attributes: + label: Severity * + description: Choose the severity of the bug. + options: + - "Critical (Game-breaking/Crash): The game crashes or a core feature (like saving, loading, or network connection) is completely unusable." + - "High (Major Disruption): A major feature is broken or incorrect, but a workaround exists." + - "Medium (Gameplay Limitation): Non-core functionality is impaired, providing a suboptimal but playable experience." + - "Low (Minor/Nuisance): Minor glitches or cosmetic issues that don’t affect gameplay and occur rarely." + validations: + required: true + + - type: markdown + attributes: + value: | + ## Brief Description * + + What happened? Please explain the issue in one or two sentences and how it stopped you from using the program. You can also upload a picture of the issue if possible. + + - type: textarea + id: brief-description + attributes: + label: Brief Description * + description: | + Please describe the issue in detail: + 1. Provide in-game screenshots if possible. + 2. If it's a rules-related issue: + - Specify the rulebook edition + - Include the page number + - Quote the relevant text + 3. If applicable, list the steps to reproduce the issue in the saved game. + placeholder: "Describe the issue here..." + validations: + required: true + + - type: markdown + attributes: + value: | + ## Steps to Reproduce + + How did the problem happen? Please list the steps you followed before the issue appeared. + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Provide a detailed numbered list of steps. + placeholder: "1. Step one\n2. Step two\n3. Step three" + + - type: markdown + attributes: + value: | + ## User Environment + + For the next sections go to the logs folder inside MegaMekLab (usually called 'logs'). Find the MegaMekLab.log file, open it with a text editor. It will look like the image below. Fill the information you find there into the following sections: + + ![Example Screenshot](https://i.imgur.com/KD8cnvf.png) + + - type: dropdown + id: operating-system + attributes: + label: Operating System * + description: What kind of computer are you using? Select your operating system (like Windows or Mac). + options: + - "Windows 11" + - "Windows 10" + - "Older Windows" + - "Mac" + - "Linux" + validations: + required: true + + - type: input + id: java-version + attributes: + label: Java Version * + description: What version of Java is on your computer? You can find this information at the top of your MegaMekLab.log file. + validations: + required: true + + - type: dropdown + id: megamek-version + attributes: + label: MegaMek Suite Version * + description: Which version of MegaMekLab are you using? Pick your version from the list. If you select "Free Text," please enter your version in the box below. + options: + - "v0.50.0" + - "v0.49.19.1" + - "v0.49.19" + - "v0.49.18" + - "v0.49.17" + - "v0.49.16" + - "v0.49.15" + - "Free Text (type manually)" + + - type: input + id: custom-megamek-version + attributes: + label: Custom MegaMekLab Version + description: If you selected "Free Text" in the version dropdown, enter your MegaMek version here. + placeholder: "Enter your MegaMek version here if it's not listed above." + + - type: markdown + attributes: + value: | + ## Files + + Please zip (compress) your logs folder and upload the file here. If you're not sure how to zip the folder, ask for help. It would also be helpful to screenshot the log header (like above) and paste it here. + + - type: textarea + id: attached-files + attributes: + label: Attach Files + description: Provide any relevant files by attaching them to the issue. + placeholder: "Drag and drop or click to upload relevant files." + + - type: checkboxes + id: final-checks + attributes: + label: Final Checklist + description: Before submitting, confirm the following steps + options: + - label: "I've checked to make sure that this issue has not already been filed" + required: true + - label: "I'm reporting only one issue in this ticket for clarity and focus" + required: true + + - type: markdown + attributes: + value: | + **You will not be able to submit this report unless all fields marked with a red asterisk (*) are complete and filled out before submitting your report.** diff --git a/.github/issue_template/config.yml b/.github/issue_template/config.yml new file mode 100644 index 000000000..53765ad91 --- /dev/null +++ b/.github/issue_template/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false + +contact_links: + - name: Questions + url: https://discord.gg/megamek + about: If you have questions about the above please ask on the Discord before selecting + + - name: MegaMek Wiki + url: https://github.com/MegaMek/megamek/wiki + about: Before opening a new issue, please check the MegaMek Wiki for information. + + - name: BattleTech Forums + url: https://bg.battletech.com/forums/index.php?board=29.0 + about: Join the discussions and find more information on the official BattleTech Forums. diff --git a/.github/issue_template/request_for_enhancement.yml b/.github/issue_template/request_for_enhancement.yml new file mode 100644 index 000000000..d69befbea --- /dev/null +++ b/.github/issue_template/request_for_enhancement.yml @@ -0,0 +1,97 @@ +name: Request for Enhancement +description: Request an enhancement for MegaMekLab. Review our Content Policy first. +title: "[RFE] Brief Description" +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + **This form is to submit a Request for Enhancement (RFE)—asking for a new feature, extending an existing feature, or implementing missing rules or errata. Submitting an RFE is no guarantee of its prioritization by the development team.** + + **Fields marked with a red asterisk (*) are mandatory to complete.** + + Before submitting an RFE, please review our [Content Policy](https://github.com/MegaMek/megamek/wiki/Unofficial-or-Non%E2%80%90Canon-Content-Policy). + + - type: checkboxes + id: prerequisites-and-pre-issue-checks + attributes: + label: Prerequisites and Pre-Issue Checklist + description: Please confirm you have completed the following steps before submitting an RFE. + options: + - label: | + I'm reporting the RFE to the correct repository: + - [MegaMek](https://github.com/MegaMek/megamek/issues) + - [MegaMekLab](https://github.com/MegaMek/megameklab/issues) + - [MekHQ](https://github.com/MegaMek/mekhq/issues) + required: true + - label: "Does this conform with our Content Policy linked above?" + required: true + - label: "I've searched the GitHub tracker and haven't found a similar feature request listed" + required: true + + - type: markdown + attributes: + value: "![How to Search the GitHub Tracker](https://i.imgur.com/QMJY7pll.png)" + + - type: dropdown + id: rfe + attributes: + label: RFE Details * + description: Please select the type of RFE you're submitting. + options: + - "This is a new feature" + - "This is an improvement to an existing feature" + - "This is an implementation of a missing official rule" + - "This is a request to implement Errata" + validations: + required: true + + - type: markdown + attributes: + value: | + For new features or improvements to existing features, please describe them in detail. + For rule implementations, provide the book, page, and edition. + For errata, reference the official documents: [Errata](https://bg.battletech.com/errata/) + + - type: textarea + id: brief-description + attributes: + label: Brief Description * + description: | + ## Brief Description of the Feature * + placeholder: | + Provide a detailed description of the requested feature, including why it's needed, any relevant use cases, and screenshots/mock-ups if applicable. + validations: + required: true + + - type: input + id: megamek-version + attributes: + label: MegaMekLab Suite Version * + description: Which version of MegaMekLab are you using? All RFEs must be checked against the most current development release. + placeholder: "e.g., v0.50.0, v0.49.19.1, or development version" + validations: + required: true + + - type: textarea + id: attached-files + attributes: + label: Attach Files + description: Provide any relevant files by attaching them to the request here. + placeholder: "Drag and drop or click to upload relevant files." + + - type: checkboxes + id: final-checks + attributes: + label: Final Checklist + description: Before submitting, confirm the following steps- + options: + - label: "I've checked to make sure that this RFE has not already been filed" + required: true + - label: "I am requesting implementation of only one relevant set of features in this ticket for clarity and focus " + required: true + + - type: markdown + attributes: + value: | + **You will not be able to submit this report unless all fields marked with a red asterisk (*) are complete and filled out before submitting your report.**