Skip to content

Commit 2f74017

Browse files
committed
Use Github Issue Templates in Bugfix
1 parent 0ced5e9 commit 2f74017

5 files changed

Lines changed: 238 additions & 40 deletions

File tree

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
name: 🪲 Report a bug
2+
description: Create a bug report to help improve Marlin Firmware
3+
title: "[BUG] (bug summary)"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
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).
9+
10+
- type: markdown
11+
attributes:
12+
value: |
13+
**Thank you for reporting a bug in Marlin Firmware!**
14+
15+
## Before Reporting a Bug
16+
17+
- Read and understand Marlin's [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/bugfix-2.0.x/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect.
18+
19+
- 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.
20+
21+
## Instructions
22+
23+
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.0.x/.github/contributing.md) for additional guidelines.
24+
25+
1. Provide a good title starting with [BUG].
26+
2. Fill out all sections of this bug report form.
27+
3. Always attach configuration files so we can build and test your setup.
28+
29+
- type: dropdown
30+
attributes:
31+
label: Did you test the latest `bugfix-2.0.x` code?
32+
description: >-
33+
Always try the latest code to make sure the issue you are reporting is not already fixed. To download
34+
the latest code just [click this link](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.0.x.zip).
35+
options:
36+
- Yes, and the problem still exists.
37+
- No, but I will test it now!
38+
validations:
39+
required: true
40+
41+
- type: markdown
42+
attributes:
43+
value: |
44+
# Bug Details
45+
46+
- type: textarea
47+
attributes:
48+
label: Bug Description
49+
description: >-
50+
Describe the bug in this section. Tell us what you were trying to do and what
51+
happened that you did not expect. Provide a clear and concise description of the
52+
problem and include as many details as possible.
53+
placeholder: |
54+
Marlin doesn't work.
55+
validations:
56+
required: true
57+
58+
- type: input
59+
attributes:
60+
label: Bug Timeline
61+
description: Is this a new bug or an old issue? When did it first start?
62+
63+
- type: textarea
64+
attributes:
65+
label: Expected behavior
66+
description: >-
67+
What did you expect to happen?
68+
placeholder: I expected it to move left.
69+
70+
- type: textarea
71+
attributes:
72+
label: Actual behavior
73+
description: What actually happened instead?
74+
placeholder: It moved right instead of left.
75+
76+
- type: textarea
77+
attributes:
78+
label: Steps to Reproduce
79+
description: >-
80+
Please describe the steps needed to reproduce the issue.
81+
placeholder: |
82+
1. [First Step] ...
83+
2. [Second Step] ...
84+
3. [and so on] ...
85+
86+
- type: markdown
87+
attributes:
88+
value: |
89+
# Your Setup
90+
91+
- type: input
92+
attributes:
93+
label: Version of Marlin Firmware
94+
description: "See the About Menu on the LCD or the output of `M115`. NOTE: For older releases we only patch critical bugs."
95+
validations:
96+
required: true
97+
98+
- type: input
99+
attributes:
100+
label: Printer model
101+
description: Creality Ender 3, Prusa mini, or Kossel Delta?
102+
103+
- type: input
104+
attributes:
105+
label: Electronics
106+
description: Stock electronics, upgrade board, or something else?
107+
108+
- type: input
109+
attributes:
110+
label: Add-ons
111+
description: Please list any hardware add-ons that could be involved.
112+
113+
- type: dropdown
114+
attributes:
115+
label: Bed Leveling
116+
description: What kind of bed leveling compensation are you using?
117+
options:
118+
- UBL Bilinear mesh
119+
- ABL Bilinear mesh
120+
- ABL Linear grid
121+
- ABL 3-point
122+
- MBL Manual Bed Leveling
123+
- No Bed Leveling
124+
125+
- type: dropdown
126+
attributes:
127+
label: Your Slicer
128+
description: Do you use Slic3r, Prusa Slicer, Simplify3D, IdeaMaker...?
129+
options:
130+
- Slic3r
131+
- Simplify3D
132+
- Prusa Slicer
133+
- IdeaMaker
134+
- Cura
135+
- Other (explain below)
136+
137+
- type: dropdown
138+
attributes:
139+
label: Host Software
140+
description: Do you use OctoPrint, Repetier Host, Pronterface...?
141+
options:
142+
- SD Card (headless)
143+
- Repetier Host
144+
- OctoPrint
145+
- Pronterface
146+
- Cura
147+
- Same as my slicer
148+
- Other (explain below)
149+
150+
- type: markdown
151+
attributes:
152+
value: >-
153+
## Other things to include
154+
155+
Please also be sure to include these items to help with troubleshooting:
156+
157+
* **A ZIP file** containing your `Configuration.h` and `Configuration_adv.h`.
158+
(Please don't paste lengthy configuration text here.)
159+
* **Log output** from the host. (`M111 S247` for maximum logging.)
160+
* **Images or videos** demonstrating the problem, if it helps to make it clear.
161+
* **A G-Code file** that exposes the problem, if not affecting _all_ G-code.
162+
163+
If you've made any other modifications to the firmware, please describe them in detail in the space provided.
164+
165+
When pasting formatted text into the box below don't forget to put ` ``` ` (on its own line) before and after to make it readable.
166+
167+
- type: textarea
168+
attributes:
169+
label: Additional information & file uploads

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Marlin Documentation
4+
url: https://marlinfw.org/
5+
about: Lots of documentation on installing and using Marlin.
6+
- name: 👤 MarlinFirmware Facebook group
7+
url: https://www.facebook.com/groups/1049718498464482
8+
about: Please ask and answer questions here.
9+
- name: 🕹 Marlin on Discord
10+
url: https://discord.gg/n5NJ59y
11+
about: Join the Discord server for support and discussion.
12+
- name: 🔗 Marlin Discussion Forum
13+
url: https://reprap.org/forum/list.php?415
14+
about: A searchable web forum hosted by RepRap dot org.
15+
- name: 📺 Marlin Videos on YouTube
16+
url: https://www.youtube.com/results?search_query=marlin+firmware
17+
about: Tutorials and more from Marlin users all around the world. Great for new users!
18+
- name: 💸 Want to donate?
19+
url: https://www.thinkyhead.com/donate-to-marlin
20+
about: Please take a look at the various options to support Marlin Firmware's development financially!
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: ✨ Request a feature
2+
description: Request a new Marlin Firmware feature
3+
title: "[FR] (feature summary)"
4+
labels: 'T: Feature Request'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
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).
10+
11+
- type: markdown
12+
attributes:
13+
value: >
14+
**Thank you for requesting a new Marlin Firmware feature!**
15+
16+
## Before Requesting a Feature
17+
18+
- 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.
19+
20+
- 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.
21+
22+
- 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.
23+
24+
- type: textarea
25+
attributes:
26+
label: Is your feature request related to a problem? Please describe.
27+
description: A clear description of the problem (e.g., "I need X but Marlin can't do it [...]").
28+
29+
- type: textarea
30+
attributes:
31+
label: Are you looking for hardware support?
32+
description: Tell us the printer, board, or peripheral that needs support.
33+
34+
- type: textarea
35+
attributes:
36+
label: Describe the feature you want
37+
description: A clear description of the feature and how you think it should work.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Additional context
44+
description: Add any other context or screenshots about the feature request here.

.github/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ If chat is more your speed, you can join the MarlinFirmware Discord server:
5050

5151
This section guides you through submitting a Bug Report for Marlin. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
5252

53-
Before creating a Bug Report, please test the "nightly" development branch, as you might find out that you don't need to create one. When you are creating a Bug Report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](issue_template.md), the information it asks for helps us resolve issues faster.
53+
Before creating a Bug Report, please test the "nightly" development branch, as you might find out that you don't need to create one. When you are creating a Bug Report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](ISSUE_TEMPLATE/bug_report.yml), the information it asks for helps us resolve issues faster.
5454

5555
> **Note:** Regressions can happen. If you find a **Closed** issue that seems like your issue, go ahead and open a new issue and include a link to the original issue in the body of your new one. All you need to create a link is the issue number, preceded by #. For example, #8888.
5656
5757
#### How Do I Submit A (Good) Bug Report?
5858

59-
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Use the New Issue button to create an issue and provide the following information by filling in [the template](issue_template.md).
59+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Use the New Issue button to create an issue and provide the following information by filling in [the template](ISSUE_TEMPLATE/bug_report.yml).
6060

6161
Explain the problem and include additional details to help maintainers reproduce the problem:
6262

@@ -88,12 +88,12 @@ Include details about your configuration and environment:
8888

8989
This section guides you through submitting a suggestion for Marlin, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
9090

91-
Before creating a suggestion, please check [this list](#before-submitting-a-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](issue_template.md), including the steps that you imagine you would take if the feature you're requesting existed.
91+
Before creating a suggestion, please check [this list](https://github.com/MarlinFirmware/Marlin/issues?q=is%3Aopen+is%3Aissue+label%3A%22T%3A+Feature+Request%22) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-feature-request). Fill in [the template](ISSUE_TEMPLATE/feature_request.yml), including the steps that you imagine you would take if the feature you're requesting existed.
9292

9393
#### Before Submitting a Feature Request
9494

9595
* **Check the [Marlin website](https://marlinfw.org/)** for tips — you might discover that the feature is already included. Most importantly, check if you're using [the latest version of Marlin](https://github.com/MarlinFirmware/Marlin/releases) and if you can get the desired behavior by changing [Marlin's config settings](https://marlinfw.org/docs/configuration/configuration.html).
96-
* **Perform a [cursory search](https://github.com/MarlinFirmware/Marlin/issues?q=is%3Aissue)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
96+
* **Perform a [cursory search](https://github.com/MarlinFirmware/Marlin/issues?q=is%3Aopen+is%3Aissue+label%3A%22T%3A+Feature+Request%22)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
9797

9898
#### How Do I Submit A (Good) Feature Request?
9999

@@ -116,7 +116,7 @@ Unsure where to begin contributing to Marlin? You can start by looking through t
116116

117117
### Pull Requests
118118

119-
Pull Requests should always be targeted to working branches (e.g., `bugfix-1.1.x` and/or `bugfix-2.0.x`) and never to release branches (e.g., `1.1.x`). If this is your first Pull Request, please read our [Guide to Pull Requests](https://marlinfw.org/docs/development/getting_started_pull_requests.html) and Github's [Pull Request](https://help.github.com/articles/creating-a-pull-request/) documentation.
119+
Pull Requests should always be targeted to working branches (e.g., `bugfix-2.0.x` and/or `bugfix-1.1.x`) and never to release branches (e.g., `2.0.x` and/or `1.1.x`). If this is your first Pull Request, please read our [Guide to Pull Requests](https://marlinfw.org/docs/development/getting_started_pull_requests.html) and Github's [Pull Request](https://help.github.com/articles/creating-a-pull-request/) documentation.
120120

121121
* Fill in [the required template](pull_request_template.md).
122122
* Don't include issue numbers in the PR title.

.github/issue_template.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)