docs: update test instructions to prefer bin/run-tests.sh;#10734
Merged
Conversation
Contributor
⚡ Try this PR in the Web FlasherNote Building this pull request… the flash button, badges and supported-board |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor/agent documentation to prefer ./bin/run-tests.sh for native unit testing, aiming to standardize sanitizer-enabled runs and provide clearer pass/fail signaling.
Changes:
- Add/expand guidance in
test/README.mdto prefer./bin/run-tests.shover rawpio test. - Update
AGENTS.mdquick reference to point at./bin/run-tests.shfor native tests. - Expand
.github/copilot-instructions.mdtesting section with./bin/run-tests.shusage and sampleRESULT:output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
test/README.md |
Adds preferred native test command (./bin/run-tests.sh) and clarifies raw pio test usage. |
AGENTS.md |
Updates agent quick-reference to prefer ./bin/run-tests.sh for native unit tests. |
.github/copilot-instructions.md |
Updates native testing instructions to prefer ./bin/run-tests.sh, including suite list and sample output. |
…count to 19; add Copilot interface caveat
21517b8 to
5a81fb5
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Basic docs update