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/en/contributing.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -290,7 +290,7 @@ The tests are divided into two categories inside the ``tests`` folder:
290
290
291
291
.. note::
292
292
293
-
Keep in mind that to run the CI scripts locally you need to have the Go-based ``yq`` from `mikefarah/yq <https://github.com/mikefarah/yq>`_
293
+
Keep in mind that to run the CI scripts locally, you need to have the Go-based ``yq`` from `mikefarah/yq <https://github.com/mikefarah/yq>`_
294
294
installed and not the Python-based ``yq`` from PyPI or `kislyuk/yq <https://github.com/kislyuk/yq>`_.
295
295
The syntax is slightly different and will not work with the CI scripts.
296
296
You can install the Go-based ``yq`` through ``brew``, ``chocolatey`` or downloading the binary directly from the `releases page <https://github.com/mikefarah/yq/releases>`_.
@@ -388,8 +388,8 @@ You can use the ``hello_world`` test suite as a starting point and the other tes
388
388
389
389
A test suite contains the following files:
390
390
391
-
* ``test_<test_name>.py``: The test file that contains the test cases. Required.
392
-
* ``<test_name>.ino``: The sketch that will be tested. Required.
391
+
* ``test_<test_name>.py``: Is the test file that contains the test cases. Required.
392
+
* ``<test_name>.ino``: This is the sketch that will be tested. Required.
393
393
* ``ci.yml``: The file that specifies how the test suite will be run in the CI system. Optional.
394
394
* ``diagram.<target>.json``: The diagram file that specifies the connections between the components in Wokwi. Optional.
395
395
* Any other files that are needed for the test suite.
0 commit comments