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
+58-53Lines changed: 58 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,18 +11,21 @@ The following is a set of guidelines for contributing to Marlin, hosted by the [
11
11
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
12
12
13
13
[How Can I Contribute?](#how-can-i-contribute)
14
-
*[Reporting Bugs](#reporting-bugs)
15
-
*[Suggesting Features or Changes](#suggesting-features-or-changes)
16
-
*[Your First Code Contribution](#your-first-code-contribution)
17
-
*[Pull Requests](#pull-requests)
14
+
15
+
-[Reporting Bugs](#reporting-bugs)
16
+
-[Suggesting Features or Changes](#suggesting-features-or-changes)
17
+
-[Your First Code Contribution](#your-first-code-contribution)
18
+
-[Pull Requests](#pull-requests)
18
19
19
20
[Styleguides](#styleguides)
20
-
*[Git Commit Messages](#git-commit-messages)
21
-
*[C++ Coding Standards](#c++-coding-standards)
22
-
*[Documentation Styleguide](#documentation)
21
+
22
+
-[Git Commit Messages](#git-commit-messages)
23
+
-[C++ Coding Standards](#c++-coding-standards)
24
+
-[Documentation Styleguide](#documentation)
23
25
24
26
[Additional Notes](#additional-notes)
25
-
*[Issue and Pull Request Labels](#issue-and-pull-request-labels)
27
+
28
+
-[Issue and Pull Request Labels](#issue-and-pull-request-labels)
26
29
27
30
## Code of Conduct
28
31
@@ -31,6 +34,7 @@ This project and everyone participating in it is governed by the [Marlin Code of
31
34
## I don't want to read this whole thing I just have a question!!!
32
35
33
36
> [!NOTE]
37
+
>
34
38
> Please don't file an issue to ask a question. You'll get faster results by using the resources below.
35
39
36
40
We have a Message Board and a Facebook group where our knowledgable user community can provide helpful advice if you have questions.
@@ -43,10 +47,10 @@ We have a Message Board and a Facebook group where our knowledgable user communi
43
47
44
48
If chat is more your speed, you can join the MarlinFirmware Discord server:
45
49
46
-
* Use the link https://discord.com/servers/marlin-firmware-461605380783472640 to join up as a General User.
47
-
* Even though our Discord is pretty active, it may take a while for community members to respond — please be patient!
48
-
* Use the `#general` channel for general questions or discussion about Marlin.
49
-
* Other channels exist for certain topics or are limited to Patrons. Check the channel list.
50
+
- Use the link https://discord.com/servers/marlin-firmware-461605380783472640 to join up as a General User.
51
+
- Even though our Discord is pretty active, it may take a while for community members to respond — please be patient!
52
+
- Use the `#general` channel for general questions or discussion about Marlin.
53
+
- Other channels exist for certain topics or are limited to Patrons. Check the channel list.
50
54
51
55
## How Can I Contribute?
52
56
@@ -57,6 +61,7 @@ This section guides you through submitting a Bug Report for Marlin. Following th
57
61
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.
58
62
59
63
> [!NOTE]
64
+
>
60
65
> 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.
61
66
62
67
#### How Do I Submit A (Good) Bug Report?
@@ -65,29 +70,29 @@ Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
65
70
66
71
Explain the problem and include additional details to help maintainers reproduce the problem:
67
72
68
-
***Use a clear and descriptive title** for the issue to identify the problem.
69
-
***Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started Marlin, e.g. which command exactly you used in the terminal, or how you started Marlin otherwise. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Marlin command, and if so which one?
70
-
***Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets or log output in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
71
-
***Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
72
-
***Explain which behavior you expected to see instead and why.**
73
-
***Include detailed log output** especially for probing and leveling. See below for usage of `DEBUG_LEVELING_FEATURE`.
74
-
***Include screenshots, links to videos, etc.** which clearly demonstrate the problem.
75
-
***Include G-code** (if relevant) that reliably causes the problem to show itself.
76
-
***If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
73
+
-**Use a clear and descriptive title** for the issue to identify the problem.
74
+
-**Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started Marlin, e.g. which command exactly you used in the terminal, or how you started Marlin otherwise. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Marlin command, and if so which one?
75
+
-**Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets or log output in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
76
+
-**Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
77
+
-**Explain which behavior you expected to see instead and why.**
78
+
-**Include detailed log output** especially for probing and leveling. See below for usage of `DEBUG_LEVELING_FEATURE`.
79
+
-**Include screenshots, links to videos, etc.** which clearly demonstrate the problem.
80
+
-**Include G-code** (if relevant) that reliably causes the problem to show itself.
81
+
-**If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
77
82
78
83
Provide more context:
79
84
80
-
***Can you reproduce the problem with a minimum of options enabled?**
81
-
***Did the problem start happening recently** (e.g. after updating to a new version of Marlin) or was this always a problem?
82
-
* If the problem started happening recently, **can you reproduce the problem in an older version of Marlin?** What's the most recent version in which the problem doesn't happen? You can download older versions of Marlin from [the releases page](https://github.com/MarlinFirmware/Marlin/releases).
83
-
***Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
85
+
-**Can you reproduce the problem with a minimum of options enabled?**
86
+
-**Did the problem start happening recently** (e.g. after updating to a new version of Marlin) or was this always a problem?
87
+
- If the problem started happening recently, **can you reproduce the problem in an older version of Marlin?** What's the most recent version in which the problem doesn't happen? You can download older versions of Marlin from [the releases page](https://github.com/MarlinFirmware/Marlin/releases).
88
+
-**Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
84
89
85
90
Include details about your configuration and environment:
86
91
87
-
***Which version of Marlin are you using?** Marlin's exact version and build date can be seen in the startup message when a host connects to Marlin, or in the LCD Info menu (if enabled).
88
-
***What kind of 3D Printer and electronics are you using**?
89
-
***What kind of add-ons (probe, filament sensor) do you have**?
90
-
***Include your Configuration files.** Make a ZIP file containing `Configuration.h` and `Configuration_adv.h` and drop it on your reply.
92
+
-**Which version of Marlin are you using?** Marlin's exact version and build date can be seen in the startup message when a host connects to Marlin, or in the LCD Info menu (if enabled).
93
+
-**What kind of 3D Printer and electronics are you using**?
94
+
-**What kind of add-ons (probe, filament sensor) do you have**?
95
+
-**Include your Configuration files.** Make a ZIP file containing `Configuration.h` and `Configuration_adv.h` and drop it on your reply.
91
96
92
97
### Suggesting Features or Changes
93
98
@@ -97,52 +102,52 @@ Before creating a suggestion, please check [this list](https://github.com/Marlin
97
102
98
103
#### Before Submitting a Feature Request
99
104
100
-
***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).
101
-
***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.
105
+
-**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).
106
+
-**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.
102
107
103
108
#### How Do I Submit A (Good) Feature Request?
104
109
105
110
Feature Requests are tracked as [GitHub issues](https://guides.github.com/features/issues/). Please follow these guidelines in your request:
106
111
107
-
***Use a clear and descriptive title** for the issue to identify the suggestion.
108
-
***Provide a step-by-step description of the requested feature** in as much detail as possible.
109
-
***Provide specific examples to demonstrate the steps**.
110
-
***Describe the current behavior** and **explain which behavior you expected to see instead** and why.
111
-
***Include screenshots and links to videos** which demonstrate the feature or point out the part of Marlin to which the request is related.
112
-
***Explain why this feature would be useful** to most Marlin users.
113
-
***Name other firmwares that have this feature, if any.**
112
+
-**Use a clear and descriptive title** for the issue to identify the suggestion.
113
+
-**Provide a step-by-step description of the requested feature** in as much detail as possible.
114
+
-**Provide specific examples to demonstrate the steps**.
115
+
-**Describe the current behavior** and **explain which behavior you expected to see instead** and why.
116
+
-**Include screenshots and links to videos** which demonstrate the feature or point out the part of Marlin to which the request is related.
117
+
-**Explain why this feature would be useful** to most Marlin users.
118
+
-**Name other firmwares that have this feature, if any.**
114
119
115
120
### Your First Code Contribution
116
121
117
122
Unsure where to begin contributing to Marlin? You can start by looking through these `good-first-issue` and `help-wanted` issues:
118
123
119
-
*[Beginner issues][good-first-issue] - issues which should only require a few lines of code, and a test or two.
120
-
*[Help Wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
124
+
-[Beginner issues][good-first-issue] - issues which should only require a few lines of code, and a test or two.
125
+
-[Help Wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
121
126
122
127
### Pull Requests
123
128
124
-
Pull Requests should always be targeted to working branches (e.g., `bugfix-2.1.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.
129
+
Pull Requests should always be targeted to working branches (e.g., `bugfix-2.1.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.
125
130
126
-
* Fill in [the required template](pull_request_template.md).
127
-
* Don't include issue numbers in the PR title.
128
-
* Include pictures, diagrams, and links to videos in your Pull Request to demonstrate your changes, if needed.
129
-
* Follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on our website.
130
-
* Document new code with clear and concise comments.
131
-
* End all files with a newline.
131
+
- Fill in [the required template](pull_request_template.md).
132
+
- Don't include issue numbers in the PR title.
133
+
- Include pictures, diagrams, and links to videos in your Pull Request to demonstrate your changes, if needed.
134
+
- Follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on our website.
135
+
- Document new code with clear and concise comments.
136
+
- End all files with a newline.
132
137
133
138
## Styleguides
134
139
135
140
### Git Commit Messages
136
141
137
-
* Use the present tense ("Add feature" not "Added feature").
138
-
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
139
-
* Limit the first line to 72 characters or fewer.
140
-
* Reference issues and Pull Requests liberally after the first line.
142
+
- Use the present tense ("Add feature" not "Added feature").
143
+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
144
+
- Limit the first line to 72 characters or fewer.
145
+
- Reference issues and Pull Requests liberally after the first line.
141
146
142
147
### C++ Coding Standards
143
148
144
-
* Please read and follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on our website. Failure to follow these guidelines will delay evaluation and acceptance of Pull Requests.
149
+
- Please read and follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on our website. Failure to follow these guidelines will delay evaluation and acceptance of Pull Requests.
145
150
146
151
### Documentation
147
152
148
-
* Guidelines for documentation are still under development. In-general, be clear, concise, and to-the-point.
153
+
- Guidelines for documentation are still under development. In-general, be clear, concise, and to-the-point.
0 commit comments