docs: fixed typos - #748
Conversation
WalkthroughThis pull request consolidates contributing guidelines by removing a generic file from the 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
104-104: Consider further tightening the wording on Line 104.Static analysis suggests two potential improvements: "in order to refine it" could be more concise, and "adequate enough" is wordy. While the current text is acceptable, consider:
- "in order to refine it" → "to refine it"
- "was not adequate enough" → "was inadequate" or "was insufficient"
These are minor polish improvements beyond the typo corrections already made.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/CONTRIBUTING.mdCONTRIBUTING.md
💤 Files with no reviewable changes (1)
- .github/CONTRIBUTING.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~104-~104: Consider a more concise word here.
Context: ...eam, and discuss the proposal with them in order to refine it. The coordination team will e...
(IN_ORDER_TO_PREMIUM)
[style] ~104-~104: ‘adequate enough’ might be wordy. Consider a shorter alternative.
Context: ...eful, but the proposed "format" was not adequate enough. --- ## Editing existing content Wh...
(EN_WORDINESS_PREMIUM_ADEQUATE_ENOUGH)
🔇 Additional comments (4)
CONTRIBUTING.md (4)
39-39: ✅ Typo correction approved.The revision on Line 39 improves sentence directness by removing the awkward parenthetical remark.
120-120: Typo corrections on quality assurance section look good.Lines 120 and 131 correctly fix spelling and improve clarity around research, validation, and proofreading guidance for contributors.
Also applies to: 131-131
398-398: Jekyll setup instructions improved.The revision on Line 398 clarifies the local development setup guidance.
1-414: PR objectives successfully addressed in consolidated guidelines.This PR accomplishes its core goals: consolidating the repository's contributing guidelines into a single canonical file (CONTRIBUTING.md at root level) and correcting multiple typographical errors throughout ("inteded" → "intended", "Finaly" → "Finally", "carefuly" → "carefully", "posible" → "possible", "whas" → "was", and others). The document is now clearer and more consistent. No code or functional impact.
One follow-up to confirm: Verify that
.github/CONTRIBUTING.mdhas been completely removed as mentioned in the PR summary, to ensure there are no conflicting guidelines files remaining.
|
Thanks @sengmonkham |
Consolidate Contributing Guidelines and Fix Typos
Fixes #747
Changes done:
Renamed
contributing_guidelines.mdtoCONTRIBUTING.mdto follow standard GitHub conventions. Removed redundant.github/CONTRIBUTING.md.Fixed multiple typographical errors inCONTRIBUTING.md.Screenshots
N/A (Documentation changes only)
Preview Link(s):
N/A
✅️ By submitting this PR, I have verified the following
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.