Skip to content

Commit

Permalink
Merge branch 'master' into feat/acar-v2
Browse files Browse the repository at this point in the history
  • Loading branch information
Scoppio authored Jan 7, 2025
2 parents 1f39721 + 95bbd7d commit 6d664d5
Show file tree
Hide file tree
Showing 395 changed files with 24,113 additions and 4,502 deletions.
187 changes: 63 additions & 124 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,169 +1,108 @@
name: Bug Report
description: Report an issue with MegaMek
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 MegaMek 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.
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 MegaMek (usually called 'logs'). Find the MegaMek.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)
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 MegaMek.log file.
validations:
required: true
value: |
## User Environment
For the next sections, go to the "logs" folder. Find the MegaMek.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 MegaMek 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: |
![Alt text](https://i.imgur.com/KD8cnvf.png)
- type: input
id: custom-megamek-version
attributes:
label: Custom MegaMek 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: "MegaMek Suite Version *"
description: "Enter your MegaMek 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.**
117 changes: 47 additions & 70 deletions .github/ISSUE_TEMPLATE/request_for_enhancement.yml
Original file line number Diff line number Diff line change
@@ -1,97 +1,74 @@
name: Request for Enhancement
description: Use this to submit a Request for Enhancement (RFE)—asking for a new feature, extending an existing feature, or implementing missing rules or errata.
title: "[RFE] Brief Description"
labels: [(RFE) Enhancement]
name: "Request for Enhancement"
description: >
Request an enhancement for MegaMek. Be sure you've confirmed it's not a duplicate
and that you've checked on the Discord if your request is already known.
title: "[RFE]"
labels:
- (RFE) 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
id: enhancement-type
attributes:
label: RFE Details *
description: Please select the type of RFE you're submitting.
label: "Enhancement Type *"
description: "Select the category of enhancement you are requesting."
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"
- "New Feature"
- "Improvement to Existing Feature"
- "Implementation of Missing Official Rule"
- "Implementation of 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 *
label: "Brief Description of Enhancement *"
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.
Please describe the feature or improvement you’d like to see.
If it's based on any official rules or errata, mention that here.
placeholder: "Describe your enhancement here..."
validations:
required: true

- type: input
id: megamek-version
- type: textarea
id: proposed-use-cases
attributes:
label: MegaMekLab Suite Version *
description: Which version of MegaMek 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
label: "Use Cases or Rationale"
description: |
Elaborate on why this enhancement is needed or valuable:
- What problem does it solve?
- How does it improve gameplay or user experience?
- Are there any related rulebook references or official errata?
placeholder: "1. ...\n2. ...\n3. ..."

- type: textarea
id: attached-files
attributes:
label: Attach Files
description: Provide any relevant files by attaching them to the request here.
label: "Attach Files"
description: |
Provide any relevant files, images, or logs that illustrate your idea or
help explain how it should work.
placeholder: "Drag and drop or click to upload relevant files."

- type: input
id: custom-megamek-version
attributes:
label: "MegaMek Suite Version *"
description: "Which version of MegaMek (or related tool) are you currently using?"
placeholder: "Example 0.50.02"
validations:
required: true

- type: checkboxes
id: final-checks
attributes:
label: Final Checklist
description: Before submitting, confirm the following steps-
label: "Final Verification"
description: "Before submitting, please confirm the following:"
options:
- label: "I've checked to make sure that this RFE has not already been filed"
- label: "I confirm this request hasn't already been submitted (checked the tracker)"
required: true
- label: "I am requesting implementation of only one relevant set of features in this ticket for clarity and focus "
- label: "I've discussed or asked about this enhancement on MegaMek Discord"
required: true
- label: "I’m opening this on the correct repo (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.**
9 changes: 9 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot

version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
Loading

0 comments on commit 6d664d5

Please sign in to comment.