-
-
Notifications
You must be signed in to change notification settings - Fork 379
docs: fix typos and update test runner reference #1523
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 our terms of service and privacy 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
WalkthroughDocumentation updates across two markdown files: typo corrections in CODE_OF_CONDUCT.md ("Maintaners" and "Mainteainers" to "Maintainers") and reference updates in CONTRIBUTING.md (unit testing description and documentation URL). Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~21-~21: Consider removing “of” to be more concise
Context: ...n dev ### Unit Testing In Elysia.js, all of the test files are located inside the [tes...
(ALL_OF_THE)
🔇 Additional comments (1)
CODE_OF_CONDUCT.md (1)
30-30: ✓ Typo corrections look good.Lines 30 and 32 correctly fix the misspellings to "Maintainers." These documentation corrections improve clarity and professionalism.
Also applies to: 32-32
| ### Unit Testing | ||
|
|
||
| In Elysia.js, all of the test files are located inside the [`test/`](test/) directory. Unit testing are powered by [bun's test](https://github.com/oven-sh/bun/tree/main/packages/bun-internal-test). | ||
| In Elysia.js, all of the test files are located inside the [`test/`](test/) directory. Unit testing are powered by [bun's test runner](https://bun.sh/docs/test). |
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.
Fix grammatical agreement and consider style improvement.
Line 21 has a subject-verb agreement issue: "Unit testing are" should be either "Unit tests are" (plural) or "Unit testing is" (singular). Additionally, the linter suggests removing "of" from "all of the test files" for more concise phrasing.
Apply this diff to fix the grammatical issue and improve style:
-In Elysia.js, all of the test files are located inside the [`test/`](test/) directory. Unit testing are powered by [bun's test runner](https://bun.sh/docs/test).
+In Elysia.js, all the test files are located inside the [`test/`](test/) directory. Unit tests are powered by [bun's test runner](https://bun.sh/docs/test).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In Elysia.js, all of the test files are located inside the [`test/`](test/) directory. Unit testing are powered by [bun's test runner](https://bun.sh/docs/test). | |
| In Elysia.js, all the test files are located inside the [`test/`](test/) directory. Unit tests are powered by [bun's test runner](https://bun.sh/docs/test). |
🧰 Tools
🪛 LanguageTool
[style] ~21-~21: Consider removing “of” to be more concise
Context: ...n dev ### Unit Testing In Elysia.js, all of the test files are located inside the [tes...
(ALL_OF_THE)
🤖 Prompt for AI Agents
In CONTRIBUTING.md around line 21, fix the grammatical and style issues: change
"In Elysia.js, all of the test files are located inside the [`test/`](test/)
directory. Unit testing are powered by [bun's test
runner](https://bun.sh/docs/test)." to use concise phrasing and correct
agreement — replace "all of the test files" with "all the test files" and "Unit
testing are powered by" with "Unit tests are powered by" (keep the existing link
to bun).
Fix spelling errors in CODE_OF_CONDUCT.md and update bun test runner reference in CONTRIBUTING.md. (bun test link was broken)
Summary by CodeRabbit
Documentation