-
-
Notifications
You must be signed in to change notification settings - Fork 19.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use Github Issue Templates in Bugfix / Update README #24199
Merged
thinkyhead
merged 2 commits into
MarlinFirmware:bugfix-2.0.x
from
thisiskeithb:pr/fix-gh-templates
May 20, 2022
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| name: 🪲 Report a bug | ||
| description: Create a bug report to help improve Marlin Firmware | ||
| title: "[BUG] (bug summary)" | ||
| 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/bugfix-2.0.x/.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/bugfix-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: 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: >- | ||
| ## 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. | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Additional information & file uploads |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: 📖 Marlin Documentation | ||
| url: https://marlinfw.org/ | ||
| about: Lots of documentation on installing and using Marlin. | ||
| - name: 👤 MarlinFirmware Facebook group | ||
| url: https://www.facebook.com/groups/1049718498464482 | ||
| about: Please ask and answer questions here. | ||
| - name: 🕹 Marlin on Discord | ||
| url: https://discord.gg/n5NJ59y | ||
| about: Join the Discord server for support and discussion. | ||
| - name: 🔗 Marlin Discussion Forum | ||
| url: https://reprap.org/forum/list.php?415 | ||
| about: A searchable web forum hosted by RepRap dot org. | ||
| - name: 📺 Marlin Videos on YouTube | ||
| url: https://www.youtube.com/results?search_query=marlin+firmware | ||
| about: Tutorials and more from Marlin users all around the world. Great for new users! | ||
| - name: 💸 Want to donate? | ||
| url: https://www.thinkyhead.com/donate-to-marlin | ||
| about: Please take a look at the various options to support Marlin Firmware's development financially! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| name: ✨ Request a feature | ||
| description: Request a new Marlin Firmware feature | ||
| title: "[FR] (feature summary)" | ||
| labels: 'T: Feature Request' | ||
| 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: textarea | ||
| attributes: | ||
| label: Additional context | ||
| description: Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link has never made much sense. We don't need to show off our amazing template. It should go to the "New Bug Report" page, but since that might be jarring no link may be best.