docs: fix test command in readme#47
Open
qkunio wants to merge 1 commit into
Open
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
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.
1. What does this PR do?
This PR fixes the test command shown in the English and Chinese READMEs.
The docs previously suggested running
bun run test, butpackage.jsondoes not define atestscript. The project uses Bun's built-in test runner directly, so the correct command isbun test.2. Why?
Following the old README command fails with:
Updating the docs keeps the contribution instructions aligned with the existing bun run check script and the guidance in AGENTS.md.
3. How is this tested?
Ran:
bun testResult:
4. Checklist
README.md uses bun test.
README.zh.md uses bun test.
Verified the documented command works locally.