-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
docs: fix grammar issue in CONTRIBUTING.md #9849
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
Conversation
|
WalkthroughUpdates CONTRIBUTING.md: minor wording edits and an expanded "Online one-click setup" with explicit build/run steps including Changes
Estimated code review effortπ― 2 (Simple) | β±οΈ ~10 minutes
Poem
Pre-merge checks and finishing touchesβ Failed checks (1 warning)
β Passed checks (2 passed)
β¨ Finishing touchesπ§ͺ Generate unit tests (beta)
π Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro π Files selected for processing (1)
π§° Additional context usedπͺ LanguageToolCONTRIBUTING.md[style] ~136-~136: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB) π Additional comments (3)
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
π§Ή Nitpick comments (1)
CONTRIBUTING.md (1)
136-136: Consider rewording to reduce phrase repetition.The phrase "If you want to" appears in nearby sentences (line 128 and here). While grammatically correct, rewording for variety would improve readability.
Consider: "To run an example without installing dependencies for the whole repo, just follow the instructions from the example's README.md file."
π Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
π Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
π§° Additional context used
πͺ LanguageTool
CONTRIBUTING.md
[style] ~136-~136: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...## Note on standalone execution If you want to run an example without installing depen...
(REP_WANT_TO_VB)
[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ck setup You can use Gitpod (An Online Open Source VS Code like IDE that is free for Open ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~140-~140: Use a hyphen to join words.
Context: ...se Gitpod (An Online Open Source VS Code like IDE that is free for Open Source) f...
(QB_NEW_EN_HYPHEN)
π Additional comments (1)
CONTRIBUTING.md (1)
142-154: Excellent expansion of Gitpod setup instructions.The addition of explicit
npm startandnpm run devcommands with clear annotations ("Auto-build files", "/docs") significantly improves clarity for contributors using the one-click setup. This makes the automated build process transparent and easier to follow.
π― Changes
β Checklist
pnpm run test:pr.π Release Impact
Summary by CodeRabbit