You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/ISSUE_TEMPLATE/bug_report.yml
+2-2
Original file line number
Diff line number
Diff line change
@@ -14,13 +14,13 @@ body:
14
14
15
15
## Before Reporting a Bug
16
16
17
-
- 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.
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
18
19
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
20
21
21
## Instructions
22
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/2.0.x/.github/contributing.md) for additional guidelines.
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.
Copy file name to clipboardexpand all lines: .github/contributing.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -50,13 +50,13 @@ If chat is more your speed, you can join the MarlinFirmware Discord server:
50
50
51
51
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.
52
52
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.
54
54
55
55
> **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.
56
56
57
57
#### How Do I Submit A (Good) Bug Report?
58
58
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).
60
60
61
61
Explain the problem and include additional details to help maintainers reproduce the problem:
62
62
@@ -88,12 +88,12 @@ Include details about your configuration and environment:
88
88
89
89
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.
90
90
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.
92
92
93
93
#### Before Submitting a Feature Request
94
94
95
95
***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.
97
97
98
98
#### How Do I Submit A (Good) Feature Request?
99
99
@@ -116,7 +116,7 @@ Unsure where to begin contributing to Marlin? You can start by looking through t
116
116
117
117
### Pull Requests
118
118
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.
120
120
121
121
* Fill in [the required template](pull_request_template.md).
Copy file name to clipboardexpand all lines: README.md
+29-16
Original file line number
Diff line number
Diff line change
@@ -10,10 +10,14 @@
10
10
Additional documentation can be found at the [Marlin Home Page](https://marlinfw.org/).
11
11
Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!
12
12
13
-
## Marlin 2.0
13
+
## Marlin 2.0 Bugfix Branch
14
+
15
+
__Not for production use. Use with caution!__
14
16
15
17
Marlin 2.0 takes this popular RepRap firmware to the next level by adding support for much faster 32-bit and ARM-based boards while improving support for 8-bit AVR boards. Read about Marlin's decision to use a "Hardware Abstraction Layer" below.
16
18
19
+
This branch is for patches to the latest 2.0.x release version. Periodically this branch will form the basis for the next minor 2.0.x release.
20
+
17
21
Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases).
18
22
19
23
## Example Configurations
@@ -22,21 +26,22 @@ Before building Marlin you'll need to configure it for your specific hardware. Y
22
26
23
27
## Building Marlin 2.0
24
28
25
-
To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](http://docs.platformio.org/en/latest/ide.html#platformio-ide). Detailed build and install instructions are posted at:
29
+
To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](https://docs.platformio.org/en/latest/ide.html#platformio-ide). We've posted detailed instructions on [Building Marlin with Arduino](https://marlinfw.org/docs/basics/install_arduino.html)and [Building Marlin with PlatformIO for ReArm](https://marlinfw.org/docs/basics/install_rearm.html) (which applies well to other 32-bit boards).
Marlin 2.0 introduces a layer of abstraction so that all the existing high-level code can be built for 32-bit platforms while still retaining full 8-bit AVR compatibility. Retaining AVR compatibility and a single code-base is important to us, because we want to make sure that features and patches get as much testing and attention as possible, and that all platforms always benefit from the latest improvements.
Proposed patches should be submitted as a Pull Request against the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch.
51
58
52
-
- Submit **Bug Fixes** as Pull Requests to the ([bugfix-2.0.x](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x)) branch.
53
-
- Follow the [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers.
54
-
- Please submit your questions and concerns to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues).
59
+
- This branch is for fixing bugs and integrating any new features for the duration of the Marlin 2.0.x life-cycle.
60
+
- Follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) to gain points with the maintainers.
61
+
- Please submit Feature Requests and Bug Reports to the [Issue Queue](https://github.com/MarlinFirmware/Marlin/issues/new/choose). Support resources are also listed there.
62
+
- Whenever you add new features, be sure to add tests to `buildroot/tests` and then run your tests locally, if possible.
63
+
- It's optional: Running all the tests on Windows might take a long time, and they will run anyway on GitHub.
64
+
- If you're running the tests on Linux (or on WSL with the code on a Linux volume) the speed is much faster.
65
+
- You can use `make tests-all-local` or `make tests-single-local TEST_TARGET=...`.
66
+
- If you prefer Docker you can use `make tests-all-local-docker` or `make tests-all-local-docker TEST_TARGET=...`.
55
67
56
68
## Marlin Support
57
69
58
70
The Issue Queue is reserved for Bug Reports and Feature Requests. To get help with configuration and troubleshooting, please use the following resources:
59
71
60
-
-[Marlin Documentation](http://marlinfw.org) - Official Marlin documentation
72
+
-[Marlin Documentation](https://marlinfw.org) - Official Marlin documentation
61
73
-[Marlin Discord](https://discord.gg/n5NJ59y) - Discuss issues with Marlin users and developers
62
74
- Facebook Group ["Marlin Firmware"](https://www.facebook.com/groups/1049718498464482/)
- Facebook Group ["Marlin Firmware for 3D Printers"](https://www.facebook.com/groups/3Dtechtalk/)
65
77
-[Marlin Configuration](https://www.youtube.com/results?search_query=marlin+configuration) on YouTube
66
78
@@ -72,15 +84,16 @@ Marlin is constantly improving thanks to a huge number of contributors from all
72
84
73
85
Regular users can open and close their own issues, but only the administrators can do project-related things like add labels, merge changes, set milestones, and kick trolls. The current Marlin admin team consists of:
74
86
75
-
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA - Project Maintainer [](http://www.thinkyhead.com/donate-to-marlin)
87
+
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA - Project Maintainer [💸 Donate](https://www.thinkyhead.com/donate-to-marlin)
76
88
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - USA
77
-
- Keith Bennett [[@thisiskeithb](https://github.com/thisiskeithb)] - USA
89
+
- Keith Bennett [[@thisiskeithb](https://github.com/thisiskeithb)] - USA [💸 Donate](https://github.com/sponsors/thisiskeithb)
90
+
- Peter Ellens [[@ellensp](https://github.com/ellensp)] - New Zealand
78
91
- Victor Oliveira [[@rhapsodyv](https://github.com/rhapsodyv)] - Brazil
79
92
- Chris Pepper [[@p3p](https://github.com/p3p)] - UK
80
93
- Jason Smith [[@sjasonsmith](https://github.com/sjasonsmith)] - USA
81
94
- Luu Lac [[@shitcreek](https://github.com/shitcreek)] - USA
82
95
- Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - USA
83
-
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)] - Netherlands [](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
96
+
- Erik van der Zalm [[@ErikZalm](https://github.com/ErikZalm)] - Netherlands [💸 Donate](https://flattr.com/submit/auto?user_id=ErikZalm&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
0 commit comments