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: CONTRIBUTING.md
+11-13Lines changed: 11 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@ This document serves as a checklist before contributing to this repository. It i
4
4
## Issues
5
5
To report a bug or a small enhancement please use the [issue tracker](http://github.com/arduino/Arduino/issues). But check the following boxes before posting an issue:
6
6
7
-
-[ ]`Your issue is NOT a question about an Arduino sketch.` Sketch questions are handled on the [Arduino Forum](http://forum.arduino.cc/).
8
-
-[ ]`Check if your issue has already been resolved in the`[hourly build](http://www.arduino.cc/en/Main/Software#hourly)
9
-
-[ ]`Your issue is not a duplicate.` So search for similar open and closed issues and pull-requests.
10
-
-[ ]`Make sure you are working on the right repository. See the table below.`
7
+
-Issue reports are NOT to be used for questions about an Arduino sketch. Sketch questions are handled on the [Arduino Forum](http://forum.arduino.cc/).
8
+
- Check if your issue has already been resolved in the [hourly build](http://www.arduino.cc/en/Main/Software#hourly)
9
+
-Search for similar open and closed issues and pull-requests.
10
+
- Make sure you are working on the right repository. See the table below:
11
11
12
12
| Issue topic | Report at |
13
13
|-|-|
@@ -26,13 +26,11 @@ To report a bug or a small enhancement please use the [issue tracker](http://git
26
26
27
27
When you're not sure where your issue belongs, report it at [arduino/Arduino](https://github.com/arduino/Arduino) and we'll move it to where it belongs (but remember: Only bug reports and feature requests, do not ask for help with your own code there).
28
28
29
-
When you have checked the previous boxes. Please consider the following points before posting the issue.
30
-
31
-
-[ ]`Describe the issue based on the behaviour you were expecting`
-[ ]`Provide a full set of steps necessary to reproduce the issue`
34
-
-[ ]`Demonstration code should be complete, correct and the minimum amount necessary to reproduce the issue`
35
-
-[ ]`Library Manager submissions: make sure your library meets all the requirements listed in the`[Library Manager FAQ](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ)
29
+
- Describe the issue based on the behaviour you were expecting
30
+
- Post complete error messages using markdown code fencing: [Markdown Code Fencing Example](https://guides.github.com/features/mastering-markdown/#examples)
31
+
- Provide a full set of steps necessary to reproduce the issue
32
+
- Demonstration code should be complete, correct and the minimum amount necessary to reproduce the issue
33
+
- Library Manager submissions: make sure your library meets all the requirements listed in the [Library Manager FAQ](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ)
36
34
37
35
## Pull Requests
38
36
This guide mainly focuses on the proper use of Git. It has some overlap with the more general information found in the [Development Policy File](https://github.com/arduino/Arduino/wiki/Development-Policy).
@@ -81,5 +79,5 @@ See also: #456, #789
81
79
```
82
80
- When different people are working on the Arduino project simultaneously, pull requests can go stale quickly. A "stale" pull request is one that is no longer up to date with the latest merges in the project. It needs to be updated before it can be merged. Most often pull requests become stale when merge conflicts occur. This happens when two pull requests both modify similar lines in the same file and one gets merged, the unmerged request will now have a merge conflict and needs updating. When your pull request is stale, you will need to rebase your branch on the current master branch before you can merge it without conflicts. More information about rebasing can be found at the repository of [edX](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request).
83
81
- When your pull request is merged please update the documentation if the changes require it:
-[ ]Submit an [issue report](https://github.com/arduino/Arduino/issues/new) requesting changes to the [arduino.cc reference pages](https://www.arduino.cc/en/Reference/HomePage)
- Submit an [issue report](https://github.com/arduino/Arduino/issues/new) requesting changes to the [arduino.cc reference pages](https://www.arduino.cc/en/Reference/HomePage)
0 commit comments