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/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
+46-80
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,10 @@ This branch is for patches to the latest 2.0.x release version. Periodically thi
20
20
21
21
Download earlier versions of Marlin on the [Releases page](https://github.com/MarlinFirmware/Marlin/releases).
22
22
23
+
## Example Configurations
24
+
25
+
Before building Marlin you'll need to configure it for your specific hardware. Your vendor should have already provided source code with configurations for the installed firmware, but if you ever decide to upgrade you'll need updated configuration files. Marlin users have contributed dozens of tested example configurations to get you started. Visit the [MarlinFirmware/Configurations](https://github.com/MarlinFirmware/Configurations) repository to find the right configuration for your hardware.
26
+
23
27
## Building Marlin 2.0
24
28
25
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).
@@ -28,80 +32,25 @@ To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino
28
32
29
33
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.
[Adafruit Grand Central M4](https://www.adafruit.com/product/4064)|[SAMD51P20A ARM-Cortex M4](https://www.microchip.com/wwwproducts/en/ATSAMD51P20A)|120MHz|1M|256k|3.3V|yes
@@ -116,18 +65,35 @@ Proposed patches should be submitted as a Pull Request against the ([bugfix-2.0.
116
65
- You can use `make tests-all-local` or `make tests-single-local TEST_TARGET=...`.
117
66
- If you prefer Docker you can use `make tests-all-local-docker` or `make tests-all-local-docker TEST_TARGET=...`.
118
67
119
-
### [RepRap.org Wiki Page](https://reprap.org/wiki/Marlin)
68
+
## Marlin Support
69
+
70
+
The Issue Queue is reserved for Bug Reports and Feature Requests. To get help with configuration and troubleshooting, please use the following resources:
71
+
72
+
-[Marlin Documentation](https://marlinfw.org) - Official Marlin documentation
73
+
-[Marlin Discord](https://discord.gg/n5NJ59y) - Discuss issues with Marlin users and developers
74
+
- Facebook Group ["Marlin Firmware"](https://www.facebook.com/groups/1049718498464482/)
- Facebook Group ["Marlin Firmware for 3D Printers"](https://www.facebook.com/groups/3Dtechtalk/)
77
+
-[Marlin Configuration](https://www.youtube.com/results?search_query=marlin+configuration) on YouTube
78
+
79
+
## Contributors
80
+
81
+
Marlin is constantly improving thanks to a huge number of contributors from all over the world bringing their specialties and talents. Huge thanks are due to [all the contributors](https://github.com/MarlinFirmware/Marlin/graphs/contributors) who regularly patch up bugs, help direct traffic, and basically keep Marlin from falling apart. Marlin's continued existence would not be possible without them.
120
82
121
-
## Credits
83
+
## Administration
122
84
123
-
The current Marlin dev team consists of:
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:
124
86
125
-
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA [Donate](https://www.thinkyhead.com/donate-to-marlin) / Flattr: [](https://flattr.com/submit/auto?user_id=thinkyhead&url=https://github.com/MarlinFirmware/Marlin&title=Marlin&language=&tags=github&category=software)
87
+
- Scott Lahteine [[@thinkyhead](https://github.com/thinkyhead)] - USA - Project Maintainer [💸 Donate](https://www.thinkyhead.com/donate-to-marlin)
126
88
- Roxanne Neufeld [[@Roxy-3D](https://github.com/Roxy-3D)] - 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
91
+
- Victor Oliveira [[@rhapsodyv](https://github.com/rhapsodyv)] - Brazil
127
92
- Chris Pepper [[@p3p](https://github.com/p3p)] - UK
93
+
- Jason Smith [[@sjasonsmith](https://github.com/sjasonsmith)] - USA
94
+
- Luu Lac [[@shitcreek](https://github.com/shitcreek)] - USA
128
95
- Bob Kuhn [[@Bob-the-Kuhn](https://github.com/Bob-the-Kuhn)] - USA
129
-
- João Brazio [[@jbrazio](https://github.com/jbrazio)] - Portugal
130
-
- 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