-
-
Notifications
You must be signed in to change notification settings - Fork 310
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
Fix typo of HOW_TO_CONTRIBUTE.md #2400
Conversation
WalkthroughThe changes involve textual corrections and formatting adjustments to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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: 0
🧹 Outside diff range and nitpick comments (1)
.github/HOW_TO_CONTRIBUTE.md (1)
22-22
: Suggestion: Further improve phrasing for concisenessWhile the typo correction from "Provite" to "Provide" is good, we can further improve this line for conciseness:
Consider applying this change to make the sentence more concise:
-1. Provide an online example. Make use of [jsFiddle](http://jsfiddle.net/), [jsBin](http://jsbin.com/). +1. Provide an online example using [jsFiddle](http://jsfiddle.net/) or [jsBin](http://jsbin.com/).This change removes the repetitive "Make use of" phrase, making the instruction more direct and easier to read.
🧰 Tools
🪛 LanguageTool
[style] ~22-~22: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...is a bug. 1. Provide an online example. Make use of jsFiddle, [jsBi...(REP_MAKE_USE_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- .github/HOW_TO_CONTRIBUTE.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/HOW_TO_CONTRIBUTE.md
[style] ~22-~22: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...is a bug. 1. Provide an online example. Make use of jsFiddle, [jsBi...(REP_MAKE_USE_OF)
🔇 Additional comments (2)
.github/HOW_TO_CONTRIBUTE.md (2)
18-18
: Approved: Improved readability and corrected typoThe changes in the "Issue Reporting" section enhance the document's clarity and correctness:
- Added line break improves readability.
- Fixed typo from "Provite" to "Provide".
- Added a period at the end of the sentence for consistency.
These modifications align well with the PR's objective of fixing typos and improve the overall quality of the contribution guidelines.
Also applies to: 22-22
Line range hint
52-52
: Approved: Corrected testing terminologyThe change from "uint test" to "unit test" in the "Test Your Change" section is correct and necessary. This fix:
- Accurately represents the type of test being referred to.
- Eliminates potential confusion for contributors.
- Aligns with standard software testing terminology.
This correction contributes to the overall goal of improving the document's accuracy and clarity.
🧰 Tools
🪛 LanguageTool
[style] ~22-~22: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness.
Context: ...is a bug. 1. Provide an online example. Make use of jsFiddle, [jsBi...(REP_MAKE_USE_OF)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2400 +/- ##
==========================================
+ Coverage 69.48% 69.49% +0.01%
==========================================
Files 522 522
Lines 27355 27355
Branches 4096 4096
==========================================
+ Hits 19008 19011 +3
+ Misses 6847 6844 -3
Partials 1500 1500
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Typo
Summary by CodeRabbit