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: docs/source/contributing.rst
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ Before Contributing
15
15
16
16
Before sending us a Pull Request, please consider this:
17
17
18
-
* Is the contribution entirely your own work, or is it already licensed under an LGPL 2.1 compatible Open Source License? If not, we, unfortunately, cannot accept it.
18
+
* Is the contribution entirely your own work, or is it already licensed under an LGPL 2.1 compatible Open Source License? If not, cannot accept it.
19
19
20
-
* Is the code adequately commented on to people understand how it is structured?
20
+
* Is the code adequately commented and can people understand how it is structured?
21
21
22
22
* Is there documentation or examples that go with code contributions?
23
23
@@ -36,7 +36,7 @@ Pull Request Process
36
36
37
37
After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
38
38
39
-
Once the Pull Request is ready to merge, it will first be merged into our internal git system for in-house automated testing.
39
+
Once the Pull Request is ready to merge, it will first be merged into our internal git system for "in-house" automated testing.
40
40
41
41
If this process passes, it will be merged into the public GitHub repository.
42
42
@@ -46,7 +46,7 @@ Example Contribution Guideline
46
46
Checklist
47
47
*********
48
48
49
-
* Check if your example proposal has no similarities to the project
49
+
* Check if your example proposal has no similarities to the project (**already existing examples**)
50
50
* Use the `Arduino style guide`_
51
51
* Add the header to all source files
52
52
* Add the `README.md` file
@@ -58,7 +58,7 @@ Header
58
58
59
59
All the source files must include the header with the example name and license, if applicable. You can change this header as you wish, but it will be reviewed by the community and may not be accepted.
60
60
61
-
Additionally, you can add some description about the example, links to the documentation, or the author's name. Just have in mind to keep it simple and short.
61
+
Ideally, you can add some description about the example, links to the documentation, or the author's name. Just have in mind to keep it simple and short.
62
62
63
63
**Header Example**
64
64
@@ -86,8 +86,12 @@ Inline Comments
86
86
87
87
Inline comments are important if the example contains complex algorithms or specific configurations that the user needs to change.
88
88
89
+
Brief and clear inline comments are really helpful for the example understanding and it's fast usage.
90
+
89
91
**Example**
90
92
93
+
See the `FTM example <https://github.com/espressif/arduino-esp32/blob/master/libraries/WiFi/examples/FTM/FTM_Initiator/FTM_Initiator.ino>`_ as a reference.
94
+
91
95
.. code-block:: arduino
92
96
93
97
// Number of FTM frames requested in terms of 4 or 8 bursts (allowed values - 0 (No pref), 16, 24, 32, 64)
0 commit comments