|
1 | | -name: Request for Enhancement |
2 | | -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. |
3 | | -title: "[RFE] Brief Description" |
4 | | -labels: [(RFE) Enhancement] |
| 1 | +name: "Request for Enhancement" |
| 2 | +description: > |
| 3 | + Request an enhancement for MekHQ. Be sure you've confirmed it's not a duplicate |
| 4 | + and that you've checked on the Discord if your request is already known. |
| 5 | +title: "[RFE]" |
| 6 | +labels: |
| 7 | + - (RFE) Enhancement |
| 8 | + |
5 | 9 | body: |
6 | | - - type: markdown |
7 | | - attributes: |
8 | | - value: | |
9 | | - **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.** |
10 | | -
|
11 | | - **Fields marked with a red asterisk (*) are mandatory to complete.** |
12 | | -
|
13 | | - Before submitting an RFE, please review our [Content Policy](https://github.com/MegaMek/megamek/wiki/Unofficial-or-Non%E2%80%90Canon-Content-Policy). |
14 | | -
|
15 | | - - type: checkboxes |
16 | | - id: prerequisites-and-pre-issue-checks |
17 | | - attributes: |
18 | | - label: Prerequisites and Pre-Issue Checklist |
19 | | - description: Please confirm you have completed the following steps before submitting an RFE. |
20 | | - options: |
21 | | - - label: | |
22 | | - I'm reporting the RFE to the correct repository: |
23 | | - - [MegaMek](https://github.com/MegaMek/megamek/issues) |
24 | | - - [MegaMekLab](https://github.com/MegaMek/megameklab/issues) |
25 | | - - [MekHQ](https://github.com/MegaMek/mekhq/issues) |
26 | | - required: true |
27 | | - - label: "Does this conform with our Content Policy linked above?" |
28 | | - required: true |
29 | | - - label: "I've searched the GitHub tracker and haven't found a similar feature request listed" |
30 | | - required: true |
31 | | - |
32 | | - - type: markdown |
33 | | - attributes: |
34 | | - value: "" |
35 | | - |
36 | 10 | - type: dropdown |
37 | | - id: rfe |
| 11 | + id: enhancement-type |
38 | 12 | attributes: |
39 | | - label: RFE Details * |
40 | | - description: Please select the type of RFE you're submitting. |
| 13 | + label: "Enhancement Type *" |
| 14 | + description: "Select the category of enhancement you are requesting." |
41 | 15 | options: |
42 | | - - "This is a new feature" |
43 | | - - "This is an improvement to an existing feature" |
44 | | - - "This is an implementation of a missing official rule" |
45 | | - - "This is a request to implement Errata" |
| 16 | + - "New Feature" |
| 17 | + - "Improvement to Existing Feature" |
| 18 | + - "Implementation of Missing Official Rule" |
| 19 | + - "Implementation of Errata" |
46 | 20 | validations: |
47 | 21 | required: true |
48 | 22 |
|
49 | | - - type: markdown |
50 | | - attributes: |
51 | | - value: | |
52 | | - For new features or improvements to existing features, please describe them in detail. |
53 | | - For rule implementations, provide the book, page, and edition. |
54 | | - For errata, reference the official documents: [Errata](https://bg.battletech.com/errata/) |
55 | | -
|
56 | 23 | - type: textarea |
57 | 24 | id: brief-description |
58 | 25 | attributes: |
59 | | - label: Brief Description * |
| 26 | + label: "Brief Description of Enhancement *" |
60 | 27 | description: | |
61 | | - ## Brief Description of the Feature * |
62 | | - placeholder: | |
63 | | - Provide a detailed description of the requested feature, including why it's needed, any relevant use cases, and screenshots/mock-ups if applicable. |
| 28 | + Please describe the feature or improvement you’d like to see. |
| 29 | + If it's based on any official rules or errata, mention that here. |
| 30 | + placeholder: "Describe your enhancement here..." |
64 | 31 | validations: |
65 | 32 | required: true |
66 | 33 |
|
67 | | - - type: input |
68 | | - id: megamek-version |
| 34 | + - type: textarea |
| 35 | + id: proposed-use-cases |
69 | 36 | attributes: |
70 | | - label: MekHQ Suite Version * |
71 | | - description: Which version of MekHQ are you using? All RFEs must be checked against the most current development release. |
72 | | - placeholder: "e.g., v0.50.0, v0.49.19.1, or development version" |
73 | | - validations: |
74 | | - required: true |
| 37 | + label: "Use Cases or Rationale" |
| 38 | + description: | |
| 39 | + Elaborate on why this enhancement is needed or valuable: |
| 40 | + - What problem does it solve? |
| 41 | + - How does it improve gameplay or user experience? |
| 42 | + - Are there any related rulebook references or official errata? |
| 43 | + placeholder: "1. ...\n2. ...\n3. ..." |
75 | 44 |
|
76 | 45 | - type: textarea |
77 | 46 | id: attached-files |
78 | 47 | attributes: |
79 | | - label: Attach Files |
80 | | - description: Provide any relevant files by attaching them to the request here. |
| 48 | + label: "Attach Files" |
| 49 | + description: | |
| 50 | + Provide any relevant files, images, or logs that illustrate your idea or |
| 51 | + help explain how it should work. |
81 | 52 | placeholder: "Drag and drop or click to upload relevant files." |
82 | 53 |
|
| 54 | + - type: input |
| 55 | + id: custom-megamek-version |
| 56 | + attributes: |
| 57 | + label: "MekHQ Suite Version *" |
| 58 | + description: "Which version of MekHQ (or related tool) are you currently using?" |
| 59 | + placeholder: "Example 0.50.02" |
| 60 | + validations: |
| 61 | + required: true |
| 62 | + |
83 | 63 | - type: checkboxes |
84 | 64 | id: final-checks |
85 | 65 | attributes: |
86 | | - label: Final Checklist |
87 | | - description: Before submitting, confirm the following steps- |
| 66 | + label: "Final Verification" |
| 67 | + description: "Before submitting, please confirm the following:" |
88 | 68 | options: |
89 | | - - label: "I've checked to make sure that this RFE has not already been filed" |
| 69 | + - label: "I confirm this request hasn't already been submitted (checked the tracker)" |
90 | 70 | required: true |
91 | | - - label: "I am requesting implementation of only one relevant set of features in this ticket for clarity and focus " |
| 71 | + - label: "I've discussed or asked about this enhancement on MegaMek Discord" |
| 72 | + required: true |
| 73 | + - label: "I’m opening this on the correct repo (MegaMek, MegaMekLab, or MekHQ)" |
92 | 74 | required: true |
93 | | - |
94 | | - - type: markdown |
95 | | - attributes: |
96 | | - value: | |
97 | | - **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.** |
0 commit comments