Change issue templates to YML
This commit is contained in:
Scott Lahteine
parent
d3d1f82f73
commit
e9f7003b70
58
.github/ISSUE_TEMPLATE/bug_report.md
vendored
58
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,58 +0,0 @@
|
|||||||
---
|
|
||||||
name: 🪲 Bug report
|
|
||||||
about: Report a bug in Marlin
|
|
||||||
title: "[BUG] (bug summary)"
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
Please follow the instructions below. Failure to do so may result in your issue being closed.
|
|
||||||
|
|
||||||
### Before Reporting a Bug
|
|
||||||
|
|
||||||
1. Test with the `bugfix-2.0.x` branch to see whether the issue still exists.
|
|
||||||
|
|
||||||
2. Get troubleshooting help from the Marlin community to confirm it's a bug and not just a configuration error. Links at https://github.com/MarlinFirmware/Marlin/issues/new/choose
|
|
||||||
|
|
||||||
### Instructions
|
|
||||||
|
|
||||||
1. Fill out every section of the template below.
|
|
||||||
|
|
||||||
2. Always attach configuration files, regardless of whether you think they are involved.
|
|
||||||
|
|
||||||
3. Read and understand Marlin's Code of Conduct. By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
### Bug Description
|
|
||||||
|
|
||||||
<!-- Describe the bug in this section. (You can remove this invisible comment.) -->
|
|
||||||
|
|
||||||
### Configuration Files
|
|
||||||
|
|
||||||
**Required:** Include a ZIP file containing `Configuration.h` and `Configuration_adv.h`.
|
|
||||||
|
|
||||||
If you've made any other modifications describe them in detail here.
|
|
||||||
|
|
||||||
### Steps to Reproduce
|
|
||||||
|
|
||||||
<!-- Describe the steps needed to reproduce the issue. (You can remove this invisible comment.) -->
|
|
||||||
|
|
||||||
1. [First Step]
|
|
||||||
2. [Second Step]
|
|
||||||
3. [and so on...]
|
|
||||||
|
|
||||||
**Expected behavior:**
|
|
||||||
|
|
||||||
<!-- Describe what you expected to happen here. (You can remove this invisible comment.) -->
|
|
||||||
|
|
||||||
**Actual behavior:**
|
|
||||||
|
|
||||||
<!-- Describe what actually happens here. (You can remove this invisible comment.) -->
|
|
||||||
|
|
||||||
#### Additional Information
|
|
||||||
|
|
||||||
* Provide pictures or links to videos that clearly demonstrate the issue.
|
|
||||||
* See [Contributing to Marlin](https://github.com/MarlinFirmware/Marlin/blob/2.0.x/.github/contributing.md) for additional guidelines.
|
|
||||||
154
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
154
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,154 @@
|
|||||||
|
name: 🪲 Report a bug
|
||||||
|
description: Create a bug report to help improve Marlin Firmware
|
||||||
|
title: "[BUG] (bug summary)"
|
||||||
|
issue_body: true
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: >
|
||||||
|
Do you want to ask a question? Are you looking for support? Please use one of the [support links](https://github.com/MarlinFirmware/Marlin/issues/new/choose).
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
**Thank you for reporting a bug in Marlin Firmware!**
|
||||||
|
|
||||||
|
## Before Reporting a Bug
|
||||||
|
|
||||||
|
- Read and understand Marlin's [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect.
|
||||||
|
|
||||||
|
- Test with the [`bugfix-2.0.x` branch](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.0.x.zip) to see whether the issue still exists.
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
|
||||||
|
Please follow the instructions below. Failure to do so may result in your issue being closed. See [Contributing to Marlin](https://github.com/MarlinFirmware/Marlin/blob/2.0.x/.github/contributing.md) for additional guidelines.
|
||||||
|
|
||||||
|
1. Provide a good title starting with [BUG].
|
||||||
|
2. Fill out all sections of this bug report form.
|
||||||
|
3. Always attach configuration files so we can build and test your setup.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: Did you test the latest `bugfix-2.0.x` code?
|
||||||
|
description: >-
|
||||||
|
Always try the latest code to make sure the issue you are reporting is not already fixed. To download
|
||||||
|
the latest code just [click this link](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.0.x.zip).
|
||||||
|
options:
|
||||||
|
- Yes, and the problem still exists.
|
||||||
|
- No, but I will test it now!
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
# Bug Details
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Bug Description
|
||||||
|
description: >-
|
||||||
|
Describe the bug in this section. Tell us what you were trying to do and what
|
||||||
|
happened that you did not expect. Provide a clear and concise description of the
|
||||||
|
problem and include as many details as possible.
|
||||||
|
placeholder: |
|
||||||
|
Marlin doesn't work.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Bug Timeline
|
||||||
|
description: Is this a new bug or an old issue? When did it first start?
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: >-
|
||||||
|
What did you expect to happen?
|
||||||
|
placeholder: I expected it to move left.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: What actually happened instead?
|
||||||
|
placeholder: It moved right instead of left.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: >-
|
||||||
|
Please describe the steps needed to reproduce the issue.
|
||||||
|
placeholder: |
|
||||||
|
1. [First Step] ...
|
||||||
|
2. [Second Step] ...
|
||||||
|
3. [and so on] ...
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
# Your Setup
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Version of Marlin Firmware
|
||||||
|
description: "See the About Menu on the LCD or the output of `M115`. NOTE: For older releases we only patch critical bugs."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Printer model
|
||||||
|
description: Creality Ender 3, Prusa mini, or Kossel Delta?
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Electronics
|
||||||
|
description: Stock electronics, upgrade board, or something else?
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Add-ons
|
||||||
|
description: Please list any hardware add-ons that could be involved.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: Your Slicer
|
||||||
|
description: Do you use Slic3r, Prusa Slicer, Simplify3D, IdeaMaker...?
|
||||||
|
options:
|
||||||
|
- Slic3r
|
||||||
|
- Simplify3D
|
||||||
|
- Prusa Slicer
|
||||||
|
- IdeaMaker
|
||||||
|
- Cura
|
||||||
|
- Other (explain below)
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: Host Software
|
||||||
|
description: Do you use OctoPrint, Repetier Host, Pronterface...?
|
||||||
|
options:
|
||||||
|
- SD Card (headless)
|
||||||
|
- Repetier Host
|
||||||
|
- OctoPrint
|
||||||
|
- Pronterface
|
||||||
|
- Cura
|
||||||
|
- Same as my slicer
|
||||||
|
- Other (explain below)
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: >-
|
||||||
|
## Other things to include
|
||||||
|
|
||||||
|
Please also be sure to include these items to help with troubleshooting:
|
||||||
|
|
||||||
|
* **A ZIP file** containing your `Configuration.h` and `Configuration_adv.h`.
|
||||||
|
(Please don't paste lengthy configuration text here.)
|
||||||
|
* **Log output** from the host. (`M111 S247` for maximum logging.)
|
||||||
|
* **Images or videos** demonstrating the problem, if it helps to make it clear.
|
||||||
|
* **A G-Code file** that exposes the problem, if not affecting _all_ G-code.
|
||||||
|
|
||||||
|
If you've made any other modifications to the firmware, please describe them in detail in the space provided.
|
||||||
|
|
||||||
|
When pasting formatted text into the box below don't forget to put ` ``` ` (on its own line) before and after to make it readable.
|
||||||
34
.github/ISSUE_TEMPLATE/feature_request.md
vendored
34
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,34 +0,0 @@
|
|||||||
---
|
|
||||||
name: 🙋 Feature request
|
|
||||||
about: Request a Feature
|
|
||||||
title: "[FR] (feature request summary)"
|
|
||||||
labels: 'T: Feature Request'
|
|
||||||
assignees: ''
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
Have you read Marlin's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md
|
|
||||||
|
|
||||||
Do you want to ask a question? Are you looking for support? Please don't post here. Instead please use one of the support links at https://github.com/MarlinFirmware/Marlin/issues/new/choose
|
|
||||||
|
|
||||||
Before filing an issue be sure to test the "bugfix" branches to see whether the issue has been resolved.
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
### Description
|
|
||||||
|
|
||||||
<!-- Description of the requested feature -->
|
|
||||||
|
|
||||||
### Feature Workflow
|
|
||||||
|
|
||||||
<!-- Please describe the feature's behavior, user interaction, etc. -->
|
|
||||||
|
|
||||||
1. [First Action]
|
|
||||||
2. [Second Action]
|
|
||||||
3. [and so on...]
|
|
||||||
|
|
||||||
#### Additional Information
|
|
||||||
|
|
||||||
* Provide pictures or links that demonstrate a similar feature or concept.
|
|
||||||
* See [How Can I Contribute](#how-can-i-contribute) for additional guidelines.
|
|
||||||
46
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
46
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
name: ✨ Request a feature
|
||||||
|
description: Request a new Marlin Firmware feature
|
||||||
|
title: "[FR] (feature summary)"
|
||||||
|
issue_body: true
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: >
|
||||||
|
Do you want to ask a question? Are you looking for support? Please use one of the [support links](https://github.com/MarlinFirmware/Marlin/issues/new/choose).
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: >
|
||||||
|
**Thank you for requesting a new Marlin Firmware feature!**
|
||||||
|
|
||||||
|
## Before Requesting a Feature
|
||||||
|
|
||||||
|
- Read and understand Marlin's [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect.
|
||||||
|
|
||||||
|
- Check the latest [`bugfix-2.0.x` branch](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.0.x.zip) to see if the feature already exists.
|
||||||
|
|
||||||
|
- Before you proceed with your request, please consider if it is necessary to make it into a firmware feature, or if it may be better suited for a slicer or host feature.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Is your feature request related to a problem? Please describe.
|
||||||
|
description: A clear description of the problem (e.g., "I need X but Marlin can't do it [...]").
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Are you looking for hardware support?
|
||||||
|
description: Tell us the printer, board, or peripheral that needs support.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe the feature you want
|
||||||
|
description: A clear description of the feature and how you think it should work.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: >
|
||||||
|
**Additional context**
|
||||||
|
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
Loading…
Reference in New Issue
Block a user