Skip to content

Commit 901f8de

Browse files
committed
docs: update contributor guide for clarity and accuracy
1 parent 2d4f461 commit 901f8de

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

docs/CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
<!-- Source: https://github.com/arduino/tooling-project-assets/blob/main/documentation-templates/contributor-guide/general/CONTRIBUTING.md -->
2-
31
# Contributor Guide
42

53
Thanks for your interest in contributing to this project!

docs/contributor-guide/development.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,32 @@ The following development tools must be available in your local environment:
88

99
- [Go](https://go.dev/dl/)
1010
- [Task](https://taskfile.dev/)
11-
- [ddb client](https://developer.android.com/tools/adb) [optionally]
11+
- [adb client](https://developer.android.com/tools/adb) [optionally]
1212

1313
## Building the Project
1414

1515
- `task init`
1616

17-
## Uploading the arduino-app-cli into the board
18-
Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board to the PC via USB.
19-
20-
- `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested.
21-
2217
## Running Checks
2318

2419
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
2520

2621
- `task fmt-check`
2722
- `task test`
2823

24+
## Testing arduino-app-cli into the board
25+
Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
26+
27+
- `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested.
28+
29+
2930
## Automatic Corrections
3031

3132
Tools are provided to automatically bring the project into compliance with some of the required checks.
3233

3334
- `task lint`
3435
- `task fmt`
36+
37+
38+
## Generate API docs
39+
If th

0 commit comments

Comments
 (0)