forked from MegaMek/megameklab
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating to a new version of the template.
- Loading branch information
Showing
1 changed file
with
63 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,169 +1,108 @@ | ||
| 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 at least 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: | | ||
|  | ||
| - 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. | ||
| name: "Report an Issue" | ||
| description: > | ||
| Please make sure you're opening the issue on the correct repo; | ||
| you've checked to make sure this isn't a duplicate, and checked | ||
| on the Discord that there is an issue and not working as intended. | ||
| title: "[Issue]" | ||
| labels: | ||
| - bug | ||
|
|
||
| body: | ||
| - type: textarea | ||
| id: brief-description | ||
| attributes: | ||
| label: Brief Description * | ||
| label: "Brief Description *" | ||
| description: | | ||
| Please describe the issue in detail: | ||
| Please describe the issue in detail. | ||
| For more detailed instructions, check out | ||
| [our wiki](https://github.com/MegaMek/megamek/wiki/Creating-an-Issue-(Bug-Report%2C-Request-for-Enhancement%2C-Errata)). | ||
| 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. | ||
| label: "3. Steps to Reproduce" | ||
| description: "Provide a detailed numbered list of steps." | ||
| placeholder: "1. Step one\n2. Step two\n3. Step three" | ||
|
|
||
| - type: markdown | ||
| - type: textarea | ||
| id: attached-files | ||
| 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: | ||
|  | ||
| label: "Attach Files" | ||
| description: "Please provide all the logs from the logs folder (zipped) and any other relevant files." | ||
| placeholder: "Drag and drop or click to upload relevant files." | ||
|
|
||
| - type: dropdown | ||
| id: operating-system | ||
| id: severity | ||
| attributes: | ||
| label: Operating System * | ||
| description: What kind of computer are you using? Select your operating system (like Windows or Mac). | ||
| label: "Severity *" | ||
| description: "Choose the severity of the bug." | ||
| options: | ||
| - "Windows 11" | ||
| - "Windows 10" | ||
| - "Older Windows" | ||
| - "Mac" | ||
| - "Linux" | ||
| - "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: input | ||
| id: java-version | ||
| - type: markdown | ||
| 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 | ||
| value: | | ||
| ## User Environment | ||
| For the next sections, go to the "logs" folder. Find the MegaMeklab.log file and open it with a text editor. The information in the header will be needed. | ||
| - type: dropdown | ||
| id: megamek-version | ||
| - type: markdown | ||
| 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)" | ||
| value: | | ||
|  | ||
| - 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." | ||
| label: "MegaMeklab Suite Version *" | ||
| description: "Enter your MegaMeklab version here" | ||
| placeholder: "Example: 0.50.02" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| - type: input | ||
| id: operating-system | ||
| 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. | ||
| label: "Operating System *" | ||
| description: "Select your operating system" | ||
| placeholder: "Please be specific with the OS, e.g. Windows 11, macOS 15 Sequoia, Linux (Ubuntu)" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: attached-files | ||
| - type: input | ||
| id: java-version | ||
| 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." | ||
| label: "Java Version *" | ||
| description: "Enter the Java version from the .log file" | ||
| placeholder: "Example: Java Vendor: Eclipse Adoptium Java Version: 17.0.11" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: final-checks | ||
| attributes: | ||
| label: Final Checklist | ||
| description: Before submitting, confirm the following steps | ||
| label: "Final Verification" | ||
| description: "Please confirm the following before submitting" | ||
| options: | ||
| - label: "I've checked to make sure that this issue has not already been filed" | ||
| - label: "I confirm this is a single, unique issue that hasn't been reported before" | ||
| required: true | ||
| - label: "I'm reporting only one issue in this ticket for clarity and focus" | ||
| - label: "I have included all necessary information and files to help reproduce this issue" | ||
| required: true | ||
| - label: "I have asked on MegaMek Discord about this issue" | ||
| required: true | ||
| - label: "I have confirmed this issue is being opened on the correct repository: MegaMek, MegaMekLab, or MekHQ" | ||
| 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.** |