Skip to content

fix grammar in README#2273

Merged
jcubic merged 2 commits into
mainfrom
grammar
Jan 20, 2026
Merged

fix grammar in README#2273
jcubic merged 2 commits into
mainfrom
grammar

Conversation

@jcubic

@jcubic jcubic commented Jan 20, 2026

Copy link
Copy Markdown
Member

I'm fixing a bug or typo

  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • squash merge the PR with commit message "fix: [Description of fix]"

I'm adding a parameter to an existing command X:

  • add parameter to the function in src/api/X.js (and src/commands/X.js if necessary)
  • document the parameter in the JSDoc comment above the function
  • add a test case in __tests__/test-X.js if possible
  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • read "Appendix A submodules" in the CONTRIBUTING.md document. Be sure to include submodule tests.

I'm adding a new command:

  • add as a new file in src/api (and src/commands if necessary)
  • add command to src/index.js
  • update __tests__/test-exports.js
  • create a test in src/__tests__
  • document the command with a JSDoc comment
  • add page to the Docs Sidebar website/sidebars.json
  • add page to the v1 Docs Sidebar website/versioned_sidebars/version-1.x-sidebars.json
  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • squash merge the PR with commit message "feat: Added 'X' command"
  • read "Appendix A submodules" in the CONTRIBUTING.md document. Be sure to include submodule tests.

Summary by CodeRabbit

  • Documentation
    • Fixed spelling and grammar in README for clarity and professionalism.
    • Corrected terminology to "semantic release" and updated the corresponding link text.
    • Revised wording (e.g., "release", "happens") to improve readability and user comprehension.

✏️ Tip: You can customize this high-level summary in your review settings.

Copilot AI review requested due to automatic review settings January 20, 2026 19:15
@coderabbitai

coderabbitai Bot commented Jan 20, 2026

Copy link
Copy Markdown

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

A documentation-only update: corrected README.md wording ("relase" → "release", "happen" → "happens") and fixed "sematic release" to "semantic release" including the hyperlink text change. No code, API, or behavior changes.

Changes

Cohort / File(s) Summary
Documentation
README.md
Fixed typos: "relase" → "release", "happen" → "happens"; corrected "sematic release" → "semantic release" and updated hyperlink text

Sequence Diagram(s)

(omitted — change is documentation-only and does not alter system interactions)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • update README #2267 — README edits that mention or adjust references to "semantic-release", similar documentation-focused corrections.

Poem

🐰 A typo here, a typo there,
I nibble errors with gentle care.
"Release" now hops into place,
Semantic words find their grace,
I leave the README with a cheerful trace.

🚥 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 'fix grammar in README' directly and accurately summarizes the main change—correcting grammar and spelling errors in the README.md 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.


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Line 251: Update the sentence to correct subject–verb agreement and match the
project's styling: change "The new release happen automatically after every PR
merge." to use "happens" and replace the link text to the official project
styling "semantic-release" (so the sentence reads something like "The new
release happens automatically after every PR merge. We use semantic-release."
with the existing URL left intact). Ensure you update the exact sentence in the
README where that line appears.

Comment thread README.md Outdated
```

The new relase happen automatically after every PR merge. We use [sematic release](https://github.com/semantic-release/semantic-release).
The new release happen automatically after every PR merge. We use [semantic release](https://github.com/semantic-release/semantic-release).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix subject–verb agreement and product styling.

“Happen” → “happens”, and consider matching the project’s official “semantic-release” styling in link text.

✏️ Proposed fix
-The new release happen automatically after every PR merge. We use [semantic release](https://github.com/semantic-release/semantic-release).
+The new release happens automatically after every PR merge. We use [semantic-release](https://github.com/semantic-release/semantic-release).
🤖 Prompt for AI Agents
In `@README.md` at line 251, Update the sentence to correct subject–verb agreement
and match the project's styling: change "The new release happen automatically
after every PR merge." to use "happens" and replace the link text to the
official project styling "semantic-release" (so the sentence reads something
like "The new release happens automatically after every PR merge. We use
semantic-release." with the existing URL left intact). Ensure you update the
exact sentence in the README where that line appears.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This pull request fixes spelling errors in the README.md file. While it corrects two typos ("relase" to "release" and "sematic" to "semantic"), there remains a grammatical error in the same sentence.

Changes:

  • Fixed spelling of "relase" to "release"
  • Fixed spelling of "sematic" to "semantic"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jcubic jcubic merged commit 5468730 into main Jan 20, 2026
8 of 9 checks passed
@jcubic jcubic deleted the grammar branch January 20, 2026 19:37
@isomorphic-git-bot

Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.36.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants