Skip to content

Conversation

@witch-factory
Copy link

@witch-factory witch-factory commented Nov 3, 2025

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

  • Fixed spelling errors in governance documentation
  • Updated unit testing documentation with revised descriptions and refreshed reference links

@coderabbitai
Copy link

coderabbitai bot commented Nov 3, 2025

Walkthrough

Documentation 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

Cohort / File(s) Change Summary
Documentation Corrections
CODE_OF_CONDUCT.md
Fixed typos in Enforcement Responsibilities section: corrected "Maintaners" and "Mainteainers" to "Maintainers" (two instances)
Documentation Updates
CONTRIBUTING.md
Updated unit testing description to reference bun's test runner instead of internal test package; updated associated documentation URL

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Typo corrections are straightforward and mechanical
  • Documentation reference updates are minimal scope
  • No logic, functional behavior, or control flow changes

Poem

A rabbit hops through docs with care,
Fixing typos here and there,
"Maintainers" now spells just right,
References gleam and clear and bright! 🐰✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'docs: fix typos and update test runner reference' accurately describes the main changes in the changeset. It covers both primary modifications: fixing typos in CODE_OF_CONDUCT.md and updating the test runner reference in CONTRIBUTING.md. The title is concise, clear, and specific enough for a teammate scanning the history to understand the primary changes.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 01d03b5 and 387f84a.

📒 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).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested 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).
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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant