- Notifications
You must be signed in to change notification settings - Fork3
docs: Add readme with CONTRIBUTING.md guidelines#58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
| 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. |
alessio-peruginiNov 10, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Arduino Apps bricks might required a docker image, in that case theorchestrator 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 theorchestrator depending on the bricks specified as dependencies in the app.yml file. | |
| Arduino Apps bricks might required a docker image, in that case thearduino-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 thearduino-app-cli depending on the bricks specified as dependencies in the app.yml file. |
Is it on purpose to reference with the name oforchestrator instead ofarduino-app-cli?
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| -[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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| -[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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| -`task board:install`itinstalls the current`arduino-app-cli` insidethe board (`adb` is needed). The password of the`ardiuno` username of the board is requested. | |
| -`task board:install` installs the currentversion of Arduino App CLI onthe 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| The following environment variables are used to configure`arduino-app-cli`: | |
| The following environment variables are used to configureArduino App CLI: |
Use official product name.
| @@ -1,64 +1,47 @@ | |||
| #Arduino App CLI | |||
| #arduino-app-cli | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| #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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Arduino CLI is licensed under the GPL-3.0 license. | |
| ArduinoAppCLI 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Please read thedocument[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:
| #Contributor Guide |
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| [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.
Motivation
Change description
Additional Notes
Reviewer checklist
main.