docs: refactor readme + guidelines #58
Open
+507
−53
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
per1234
added
documentation
per1234
requested changes
Nov 10, 2025
dido18
changed the title
mirkoCrobu
reviewed
Nov 12, 2025
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
Co-authored-by: Per Tillisch <accounts@perglass.com>
…clarifying version prompts
dido18
force-pushed
the
add-readme-contributing
branch
from
2d62074 to
6983bf9
Compare
lucarin91
requested changes
Nov 13, 2025
| Checks and tests are set up to ensure the project content is functional and compliant with the established standards. | ||
|
|
||
| - `task fmt-check` | ||
| - `task test` |
Contributor
There was a problem hiding this comment.
Add a note that some tests don't work on Windows and macOS.
In particular, task test runs
test:pkgwhich exposes cross-platform api for working with the board (those should run for every platform)test:internalruns test of the internal component of the app-cli, which targets only Linux
| The following development tools must be available in your local environment: | ||
|
|
||
| - [Go](https://go.dev/dl/) | ||
| - [Task](https://taskfile.dev/) |
Contributor
There was a problem hiding this comment.
You also need Docker to run most of the tests
Co-authored-by: Luca Rinaldi <l.rinaldi@arduino.cc>
Co-authored-by: Luca Rinaldi <l.rinaldi@arduino.cc>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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
Going open source, we need a better issue-reporting mechanism and better documentation.
Change description
docsfolder withContributing.mdguidecontribute-guidewith the markdown guideuser-documentation.mdwith an initial documentation of the arduino-app-cliISSUE_TEMPLATEfolder with two types of issues "Bug report" or "Feature request"arduino-app-cli:build:local:intobuldandarduino-app-cli:startintostartAdditional Notes
Taken from https://github.com/arduino/tooling-project-assets/
beta-testinghas not been addedReviewer checklist
main.