pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update example README template and other related docs

Browse Source
This commit is contained in:
kirill.chalov
2024-04-09 18:19:03 +08:00
parent 85ea59f417
commit 0dfd78800f
5 changed files with 158 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/contribute/creating-examples.rst
-1
View File
@@ -24,7 +24,6 @@ Checklist
Checklist before submitting a new example:
* Example project name (in ``README.md``) uses the word "example". Use "example" instead of "demo", "test" or similar words.
* Example does one distinct thing. If the example does more than one thing at a time, split it into two or more examples.
* Example has a ``README.md`` file which is similar to the :idf_file:`template example README <docs/TEMPLATE_EXAMPLE_README.md>`.
* Functions and variables in the example are named according to :ref:`naming section of the style guide <style-guide-naming>`. For non-static names which are only specific to the example's source files, you can use ``example`` or something similar as a prefix.