Skip to content

Commit 0514414

Browse files
committed
PR review changes with some typos and grammar fixes
1 parent 01a47fd commit 0514414

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

docs/source/contributing.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,17 @@ Before Contributing
1515

1616
Before sending us a Pull Request, please consider this:
1717

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.
1919

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?
2121

2222
* Is there documentation or examples that go with code contributions?
2323

2424
* Are comments and documentation written in clear English, with no spelling or grammar errors?
2525

2626
* 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.
2829

2930
* 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/>`_?
3031

@@ -33,35 +34,35 @@ If you're unsure about any of these points, please open the Pull Request anyhow
3334
Pull Request Process
3435
--------------------
3536

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.
3738

3839
Once the Pull Request is ready to merge, it will first be merged into our internal git system for in-house automated testing.
3940

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.
4142

4243
Example Contribution Guideline
4344
------------------------------
4445

4546
Checklist
4647
*********
4748

48-
* Check if your example proposal has no similar in the project
49+
* Check if your example proposal has no similarities to the project
4950
* Use the `Arduino style guide`_
5051
* Add the header to all source files
51-
* Add the `README.md` file
52+
* Add the `README.md` file
5253
* Add inline comments if needed
5354
* Test the example
5455

5556
Header
5657
******
5758

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.
5960

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.
6162

6263
**Header Example**
6364

64-
.. code-block:: arduino
65+
.. code-block:: arduino
6566
6667
/* Wi-Fi FTM Initiator Arduino Example
6768
@@ -76,44 +77,44 @@ Additionaly, you can add some description about the example, links to the docume
7677
README file
7778
***********
7879

79-
The **README.md** file should contain the example details.
80+
The **README.md** file should contain the example details.
8081
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>`_.
8283
8384
Inline Comments
8485
***************
8586

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.
8788

8889
**Example**
8990

90-
.. code-block:: arduino
91+
.. code-block:: arduino
9192
9293
// Number of FTM frames requested in terms of 4 or 8 bursts (allowed values - 0 (No pref), 16, 24, 32, 64)
9394
9495
and
9596

96-
.. code-block:: arduino
97+
.. code-block:: arduino
9798
9899
const char * WIFI_FTM_SSID = "WiFi_FTM_Responder"; // SSID of AP that has FTM Enabled
99100
const char * WIFI_FTM_PASS = "ftm_responder"; // STA Password
100101
101102
Testing
102103
*******
103104

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.
105106
106107
**Example**
107108

108-
.. code-block:: arduino
109+
.. code-block:: arduino
109110
110111
/*
111112
THIS FEATURE IS SUPPORTED ONLY BY ESP32-S2 AND ESP32-C3
112113
*/
113114
114115
and
115116

116-
.. code-block:: markdown
117+
.. code-block:: markdown
117118
118119
Currently, this example supports the following targets.
119120
@@ -123,11 +124,11 @@ and
123124
Example Template
124125
****************
125126

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.
127128

128129
Legal Part
129130
----------
130131

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 contributor agreement. You will be prompted for this automatically as part of the Pull Request process.
132133

133134
.. _Arduino style guide: https://www.arduino.cc/en/Reference/StyleGuide

0 commit comments

Comments
 (0)