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
+21-20Lines changed: 21 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -15,16 +15,17 @@ 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, we, unfortunately, cannot accept it.
19
19
20
-
* Is the code adequately commented for people to understand how it is structured?
20
+
* Is the code adequately commented on to people understand how it is structured?
21
21
22
22
* Is there documentation or examples that go with code contributions?
23
23
24
24
* Are comments and documentation written in clear English, with no spelling or grammar errors?
25
25
26
26
* Example contributions are also welcome.
27
-
* If you are contributing by adding a new example, please use the `Arduino style guide`_ and the example guideline below.
27
+
28
+
* If you are contributing by adding a new example, please use the `Arduino style guide`_ and the example guideline below.
28
29
29
30
* If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" `squashed into previous commits <https://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/>`_?
30
31
@@ -33,35 +34,35 @@ If you're unsure about any of these points, please open the Pull Request anyhow
33
34
Pull Request Process
34
35
--------------------
35
36
36
-
After you open the Pull Request, there will probably be some discussion in the comments' field of the request itself.
37
+
After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
37
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
40
40
-
If this process passes, it will be merged onto the public github repository.
41
+
If this process passes, it will be merged into the public GitHub repository.
41
42
42
43
Example Contribution Guideline
43
44
------------------------------
44
45
45
46
Checklist
46
47
*********
47
48
48
-
* Check if your example proposal has no similar in the project
49
+
* Check if your example proposal has no similarities to the project
49
50
* Use the `Arduino style guide`_
50
51
* Add the header to all source files
51
-
* Add the `README.md`file
52
+
* Add the `README.md`file
52
53
* Add inline comments if needed
53
54
* Test the example
54
55
55
56
Header
56
57
******
57
58
58
-
All the source files must include the header with the example name and license, if applicable. You can change this header as you with, but it will be reviewed by the community and may not be accepted.
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.
59
60
60
-
Additionaly, you can add some description about the example, links to the documentation or authors name. Just have in mind to keep it simple and short.
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
62
62
63
**Header Example**
63
64
64
-
.. code-block::arduino
65
+
.. code-block::arduino
65
66
66
67
/* Wi-Fi FTM Initiator Arduino Example
67
68
@@ -76,44 +77,44 @@ Additionaly, you can add some description about the example, links to the docume
76
77
README file
77
78
***********
78
79
79
-
The **README.md**file should contain the example details.
80
+
The **README.md**file should contain the example details.
80
81
81
-
Please see the recommended **README.md**file in the `example template folder <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/Template/ExampleTemplate>`_.
82
+
Please see the recommended **README.md**file in the `example template folder <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/Template/ExampleTemplate>`_.
82
83
83
84
Inline Comments
84
85
***************
85
86
86
-
Inline comments are important if the example contains complex algorithms os specific configuration that the user needs to change.
87
+
Inline comments are important if the example contains complex algorithms or specific configurations that the user needs to change.
87
88
88
89
**Example**
89
90
90
-
.. code-block::arduino
91
+
.. code-block::arduino
91
92
92
93
// Number of FTM frames requested in terms of 4 or 8 bursts (allowed values - 0 (No pref), 16, 24, 32, 64)
93
94
94
95
and
95
96
96
-
.. code-block::arduino
97
+
.. code-block::arduino
97
98
98
99
const char * WIFI_FTM_SSID = "WiFi_FTM_Responder"; // SSID of AP that has FTM Enabled
99
100
const char * WIFI_FTM_PASS = "ftm_responder"; // STA Password
100
101
101
102
Testing
102
103
*******
103
104
104
-
Be sure you have tested the example in all the supported targets. If the example works only with specific targets, add this information in the **README.md**file on the **Supported Targets**and in the example code as inline comment.
105
+
Be sure you have tested the example in all the supported targets. If the example works only with specific targets, add this information in the **README.md**file on the **Supported Targets**and in the example code as an inline comment.
105
106
106
107
**Example**
107
108
108
-
.. code-block::arduino
109
+
.. code-block::arduino
109
110
110
111
/*
111
112
THIS FEATURE IS SUPPORTED ONLY BY ESP32-S2 AND ESP32-C3
112
113
*/
113
114
114
115
and
115
116
116
-
.. code-block::markdown
117
+
.. code-block::markdown
117
118
118
119
Currently, this example supports the following targets.
119
120
@@ -123,11 +124,11 @@ and
123
124
Example Template
124
125
****************
125
126
126
-
The example template can be found `here <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/Template/ExampleTemplate>`_and can be used as a reference.
127
+
The example template can be found `here <https://github.com/espressif/arduino-esp32/tree/master/libraries/ESP32/examples/Template/ExampleTemplate>`_and can be used as a reference.
127
128
128
129
Legal Part
129
130
----------
130
131
131
-
Before a contribution can be accepted, you will need to sign our contributor-agreement. You will be prompted for this automatically as part of the Pull Request process.
132
+
Before a contribution can be accepted, you will need to sign our contributoragreement. You will be prompted for this automatically as part of the Pull Request process.
0 commit comments