Skip to content

docs: fix typos in README.md#2037

Open
cairon-ab wants to merge 2 commits intoasyncapi:masterfrom
cairon-ab:docs/fix-readme-typos
Open

docs: fix typos in README.md#2037
cairon-ab wants to merge 2 commits intoasyncapi:masterfrom
cairon-ab:docs/fix-readme-typos

Conversation

@cairon-ab
Copy link
Copy Markdown

@cairon-ab cairon-ab commented Mar 30, 2026

Description

Fixes several typos in the root README.md:

  • "basing on""based on" (2 occurrences: package description and Overview section)
  • "undestand""understand" (React-sdk description)
  • "Developement""Development" (Contributing section link text)

These are simple text corrections with no functional changes.

Summary by CodeRabbit

  • Documentation
    • Fixed grammar and spelling across the README: corrected “basing on” → “based on” in the Generator description and Overview, corrected “undestand” → “understands” in the React SDK description, and fixed the “Developement guide” typo to “Development guide” in the Contributing link. These edits improve clarity without changing functionality.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 30, 2026

⚠️ No Changeset found

Latest commit: 5e5bbe4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Copy Markdown
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@asyncapi-bot
Copy link
Copy Markdown
Contributor

What reviewer looks at during PR review

The following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.

  1. PR Title: Use a concise title that follows our Conventional Commits guidelines and clearly summarizes the change using imperative mood (it means spoken or written as if giving a command or instruction, like "add new helper for listing operations")

    Note - In Generator, prepend feat: or fix: in PR title only when PATCH/MINOR release must be triggered.

  2. PR Description: Clearly explain the issue being solved, summarize the changes made, and mention the related issue.

    Note - In Generator, we use Maintainers Work board to track progress. Ensure the PR Description includes Resolves #<issue-number> or Fixes #<issue-number> this will automatically close the linked issue when the PR is merged and helps automate the maintainers workflow.

  3. Documentation: Update the relevant Generator documentation to accurately reflect the changes introduced in the PR, ensuring users and contributors have up-to-date guidance.

  4. Comments and JSDoc: Write clear and consistent JSDoc comments for functions, including parameter types, return values, and error conditions, so others can easily understand and use the code.

  5. DRY Code: Ensure the code follows the Don't Repeat Yourself principle. Look out for duplicate logic that can be reused.

  6. Test Coverage: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases.

  7. Commit History: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates.

  8. Template Design Principles Alignment: While reviewing template-related changes in the packages/ directory, ensure they align with the Assumptions and Principles. If any principle feels outdated or no longer applicable, start a discussion these principles are meant to evolve with the project.

  9. Reduce Scope When Needed: If an issue or PR feels too large or complex, consider splitting it and creating follow-up issues. Smaller, focused PRs are easier to review and merge.

  10. Bot Comments: As reviewers, check that contributors have appropriately addressed comments or suggestions made by automated bots. If there are bot comments the reviewer disagrees with, react to them or mark them as resolved, so the review history remains clear and accurate.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4f7c6fcd-d418-4fad-b0b8-cdc3571c08d3

📥 Commits

Reviewing files that changed from the base of the PR and between bbab8dc and 5e5bbe4.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Updated README.md with three non-functional text fixes: "basing on" → "based on" in the Generator description, "undestand" → "understands" in the React-sdk description, and "Developement guide" → "Development guide" in the Contributing section.

Changes

Cohort / File(s) Summary
Documentation corrections
README.md
Typographical and grammar fixes: replaced "basing on" with "based on" (Generator), corrected "undestand" to "understands" (React-sdk), and fixed "Developement guide" to "Development guide" (Contributing link).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix typos in README.md' follows Conventional Commits guidelines with the 'docs:' prefix, uses imperative mood ('fix'), and accurately summarizes the changes made to the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Copy Markdown

@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.

🧹 Nitpick comments (1)
README.md (1)

9-9: Optional: Fix subject-verb agreement.

The phrase "the library that understand" should use "understands" for proper subject-verb agreement with the singular noun "library."

📝 Suggested grammar improvement
-1. [React-sdk](apps/react-sdk): AsyncAPI React SDK is a set of components/functions to use React as render engine for the generator. This is the library that understand components from Generator's templates that are configured to use `react` render engine. 
+1. [React-sdk](apps/react-sdk): AsyncAPI React SDK is a set of components/functions to use React as render engine for the generator. This is the library that understands components from Generator's templates that are configured to use `react` render engine.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 9, The README sentence "This is the library that
understand components..." has a subject-verb agreement error; update the phrase
in the React-sdk description (the sentence containing "the library that
understand components from Generator's templates") to use "understands" instead
of "understand" so it reads "the library that understands components from
Generator's templates that are configured to use `react` render engine."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 9: The README sentence "This is the library that understand
components..." has a subject-verb agreement error; update the phrase in the
React-sdk description (the sentence containing "the library that understand
components from Generator's templates") to use "understands" instead of
"understand" so it reads "the library that understands components from
Generator's templates that are configured to use `react` render engine."

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7ec3f81e-7fed-48c2-baf8-eb095d2c60b4

📥 Commits

Reviewing files that changed from the base of the PR and between bd121dd and bbab8dc.

📒 Files selected for processing (1)
  • README.md

Apply CodeRabbit suggestion: 'understand' → 'understands' for subject-verb agreement.
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 1, 2026

@SHUBHANSHU602
Copy link
Copy Markdown
Contributor

mention issue please

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.

3 participants