docs: Add readme with CONTRIBUTING.md guidelines #58
+372
−42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+54
to
+56
| Arduino Apps bricks might required a docker image, in that case the orchestrator will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). | ||
|
|
||
| The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the orchestrator depending on the bricks specified as dependencies in the app.yml file. |
Contributor
There was a problem hiding this comment.
Suggested change
| Arduino Apps bricks might required a docker image, in that case the orchestrator will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). | |
| The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the orchestrator depending on the bricks specified as dependencies in the app.yml file. | |
| Arduino Apps bricks might required a docker image, in that case the arduino-app-cli will pull those from the registry configured with the `DOCKER_REGISTRY_BASE` environment variable. By default this points to an Arduino GitHub Container Registry (ghcr.io/arduino). | |
| The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the arduino-app-cli depending on the bricks specified as dependencies in the app.yml file. |
Is it on purpose to reference with the name of orchestrator instead of arduino-app-cli?
per1234
added
documentation
per1234
requested changes
Nov 10, 2025
| The following development tools must be available in your local environment: | ||
|
|
||
| - [Go](https://go.dev/dl/) | ||
| - [Taskfile](https://taskfile.dev/) |
There was a problem hiding this comment.
Suggested change
| - [Taskfile](https://taskfile.dev/) | |
| - [Task](https://taskfile.dev/) |
The tool's name is "Task"
|
|
||
| - [Go](https://go.dev/dl/) | ||
| - [Taskfile](https://taskfile.dev/) | ||
| - [ddb client]//https://developer.android.com/tools/adb) [optionally] |
There was a problem hiding this comment.
Suggested change
| - [ddb client]//https://developer.android.com/tools/adb) [optionally] | |
| - [ddb client](https://developer.android.com/tools/adb) [optionally] |
Fix markup.
| - `task init` | ||
|
|
||
| ## Uploading the arduino-app-cli into the board | ||
| Connect an [Arduino UNO Q](https://www.arduino.cc/product-uno-q) board to the PC via USB. |
There was a problem hiding this comment.
Suggested change
| Connect an [Arduino UNO Q](https://www.arduino.cc/product-uno-q) board to the PC via USB. | |
| Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board to the PC via USB. |
From experience with the way the Arduino website is maintained, the previous URL is likely to stop working at some point in the future. The documentation pages are the most stable link targets (they typically only break when the URL changes after the product is retired).
| ## Uploading the arduino-app-cli into the board | ||
| Connect an [Arduino UNO Q](https://www.arduino.cc/product-uno-q) board to the PC via USB. | ||
|
|
||
| - `task board:install` it installs the current `arduino-app-cli` inside the board (`adb` is needed). The password of the `ardiuno` username of the board is requested. |
There was a problem hiding this comment.
Suggested change
| - `task board:install` it installs the current `arduino-app-cli` inside the board (`adb` is needed). The password of the `ardiuno` username of the board is requested. | |
| - `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. |
- Grammar fixes
- Use official product name
- Correct username
|
|
||
| High quality bug reports and feature requests are valuable contributions to this project. These can be made by submitting an issue report to the project's GitHub repository: | ||
|
|
||
| https://github.com/arduino/TODO_REPO_NAME/issues/new/choose |
There was a problem hiding this comment.
Suggested change
| https://github.com/arduino/TODO_REPO_NAME/issues/new/choose | |
| https://github.com/arduino/arduino-app-cli/issues/new/choose |
| @@ -0,0 +1,56 @@ | |||
| ## Environment Variables | |||
|
|
|||
| The following environment variables are used to configure `arduino-app-cli`: | |||
There was a problem hiding this comment.
Suggested change
| The following environment variables are used to configure `arduino-app-cli`: | |
| The following environment variables are used to configure Arduino App CLI: |
Use official product name.
| @@ -1,64 +1,47 @@ | |||
| # Arduino App CLI | |||
| # arduino-app-cli | |||
There was a problem hiding this comment.
Suggested change
| # arduino-app-cli | |
| # Arduino App CLI |
Use official product name. arduino-app-cli should only be used when referring to the command line invocation.
| ## License | ||
|
|
||
| ### Docker Settings | ||
| Arduino CLI is licensed under the GPL-3.0 license. |
There was a problem hiding this comment.
Suggested change
| Arduino CLI is licensed under the GPL-3.0 license. | |
| Arduino App CLI is licensed under the GPL-3.0 license. |
| Contributions are welcome! | ||
|
|
||
| ### Execution Settings | ||
| Please read the document [How to contribute] which will show you how to build the source code, run the tests, and |
There was a problem hiding this comment.
Suggested change
| Please read the document [How to contribute] which will show you how to build the source code, run the tests, and | |
| Please read the [Contributor Guide] document, which will show you how to build the source code, run the tests, and |
See:
arduino-app-cli/docs/CONTRIBUTING.md
Line 3 in a85d3f9
|
|
||
| The only image that needs to be referenced directly is the base Python image (`DOCKER_PYTHON_BASE_IMAGE`), all other containers can be downloaded automatically by the orchestrator depending on the bricks specified as dependencies in the app.yml file. | ||
| [user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md | ||
| [how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ |
There was a problem hiding this comment.
Suggested change
| [how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ | |
| [contributor guide]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/ |
This accompanies my suggestion above.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Change description
Additional Notes
Reviewer checklist
main.