Skip to content

Commit e88f547

Browse files
committed
Changes according to the PR review
1 parent 5638047 commit e88f547

File tree

2 files changed

+9
-55
lines changed

2 files changed

+9
-55
lines changed

CONTRIBUTING.rst

Lines changed: 0 additions & 50 deletions
This file was deleted.

docs/source/contributing.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ 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, cannot accept it.
1919

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

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

@@ -36,7 +36,7 @@ Pull Request Process
3636

3737
After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
3838

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

4141
If this process passes, it will be merged into the public GitHub repository.
4242

@@ -46,7 +46,7 @@ Example Contribution Guideline
4646
Checklist
4747
*********
4848

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**)
5050
* Use the `Arduino style guide`_
5151
* Add the header to all source files
5252
* Add the `README.md` file
@@ -58,7 +58,7 @@ Header
5858

5959
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.
6060

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

6363
**Header Example**
6464

@@ -86,8 +86,12 @@ Inline Comments
8686

8787
Inline comments are important if the example contains complex algorithms or specific configurations that the user needs to change.
8888

89+
Brief and clear inline comments are really helpful for the example understanding and it's fast usage.
90+
8991
**Example**
9092

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+
9195
.. code-block:: arduino
9296
9397
// Number of FTM frames requested in terms of 4 or 8 bursts (allowed values - 0 (No pref), 16, 24, 32, 64)

0 commit comments

Comments
 (0)