mirror of
https://github.com/MarlinFirmware/Configurations.git
synced 2025-07-06 22:47:35 -06:00
✅ Update GitHub templates (#1073)
This commit is contained in:
Keith Bennett
GitHub
parent
28b8be2617
commit
9e20473e62
4 changed files with 187 additions and 62 deletions
59
.github/ISSUE_TEMPLATE/bug_report.md
vendored
59
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,59 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Report a bug in a Marlin Configuration
|
|
||||||
title: "[BUG] (short description)"
|
|
||||||
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 `import-2.0.x` branch to see whether the issue still exists. This will require testing with the Marlin `bugfix-2.0.x` branch.
|
|
||||||
|
|
||||||
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/Configurations/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.
|
|
||||||
184
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
184
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,184 @@
|
||||||
|
name: 🪲 Report a bug
|
||||||
|
description: Report a bug in a Marlin Configuration
|
||||||
|
title: "[BUG] (short description)"
|
||||||
|
labels: ["bug"]
|
||||||
|
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/Configurations/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/bugfix-2.1.x/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect.
|
||||||
|
|
||||||
|
- Test with the Configurations [`bugfix-2.1.x` branch](https://github.com/MarlinFirmware/Configurations/archive/bugfix-2.1.x.zip) branch to see whether the issue still exists. This will require testing with the Marlin [`bugfix-2.1.x` branch](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.1.x.zip).
|
||||||
|
|
||||||
|
## 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/bugfix-2.1.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.1.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.1.x.zip). Matching configs can be [downloaded here](https://github.com/MarlinFirmware/Configurations/archive/bugfix-2.1.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.
|
||||||
|
|
||||||
|
When pasting formatted text don't forget to put ` ``` ` (on its own line) before and after to make it readable.
|
||||||
|
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: LCD/Controller
|
||||||
|
description: Some Marlin behaviors are determined by the controller. Describe your LCD/Controller model and version.
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Other add-ons
|
||||||
|
description: Please list any other hardware add-ons that could be involved.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: Bed Leveling
|
||||||
|
description: What kind of bed leveling compensation are you using?
|
||||||
|
options:
|
||||||
|
- UBL Bilinear mesh
|
||||||
|
- ABL Bilinear mesh
|
||||||
|
- ABL Linear grid
|
||||||
|
- ABL 3-point
|
||||||
|
- MBL Manual Bed Leveling
|
||||||
|
- No Bed Leveling
|
||||||
|
|
||||||
|
- 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: |
|
||||||
|
# Attachments
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Don't forget to include
|
||||||
|
options:
|
||||||
|
- label: A ZIP file containing your `Configuration.h` and `Configuration_adv.h`.
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
### Optional items to include:
|
||||||
|
- '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.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional information & file uploads
|
||||||
|
description: >-
|
||||||
|
If you've made any other modifications to the firmware, please describe them in detail.
|
||||||
|
|
||||||
|
When pasting formatted text don't forget to put ` ``` ` (on its own line) before and after to make it readable.
|
||||||
4
.github/contributing.md
vendored
4
.github/contributing.md
vendored
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
- Make a fork of this repository under your account.
|
- Make a fork of this repository under your account.
|
||||||
- Use Clone or Download to open the repo on your computer.
|
- Use Clone or Download to open the repo on your computer.
|
||||||
- Use Git or Github Desktop to checkout the `import-2.0.x` branch.
|
- Use Git or Github Desktop to checkout the `import-2.1.x` branch.
|
||||||
- Add new configurations and/or make changes to existing ones.
|
- Add new configurations and/or make changes to existing ones.
|
||||||
- Commit your changes and push them to your fork.
|
- Commit your changes and push them to your fork.
|
||||||
- Submit a Pull Request to the `import-2.0.x` branch.
|
- Submit a Pull Request to the `import-2.1.x` branch.
|
||||||
|
|
|
||||||
2
.github/workflows/check-pr.yml
vendored
2
.github/workflows/check-pr.yml
vendored
|
|
@ -1,6 +1,6 @@
|
||||||
#
|
#
|
||||||
# check-pr.yml
|
# check-pr.yml
|
||||||
# Close PRs directed at `bugfix-2.0.x`
|
# Close PRs directed at `bugfix-2.x.x`
|
||||||
#
|
#
|
||||||
|
|
||||||
name: PR Bad Target
|
name: PR Bad Target
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue