Skip to content

docs: fixed typos - #748

Merged
tachyons merged 1 commit into
CircuitVerse:masterfrom
sengmonkham:fix/documentation-issues
Jan 15, 2026
Merged

docs: fixed typos#748
tachyons merged 1 commit into
CircuitVerse:masterfrom
sengmonkham:fix/documentation-issues

Conversation

@sengmonkham

@sengmonkham sengmonkham commented Jan 11, 2026

Copy link
Copy Markdown
Contributor

Consolidate Contributing Guidelines and Fix Typos

Fixes #747

Changes done:

Renamed contributing_guidelines.md to CONTRIBUTING.md to follow standard GitHub conventions. Removed redundant .github/CONTRIBUTING.md.Fixed multiple typographical errors in CONTRIBUTING.md.

Screenshots

N/A (Documentation changes only)

Preview Link(s):

N/A

✅️ By submitting this PR, I have verified the following

  • Checked to see if a similar PR has already been opened 🤔️
  • Reviewed the contributing guidelines 🔍️
  • Sample preview link added (add the link(s) for all the pages changed/updated from the checks tab after checks complete)
  • Tried Squashing the commits into one

Summary by CodeRabbit

  • Documentation
    • Removed contributing guidelines documentation.
    • Corrected spelling and grammar in contributing documentation.

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

@coderabbitai

coderabbitai Bot commented Jan 11, 2026

Copy link
Copy Markdown

Walkthrough

This pull request consolidates contributing guidelines by removing a generic file from the .github/ directory and updating the remaining contribution documentation with corrections. Multiple typos and spelling errors were fixed, including "inteded" to "intended," "Finaly" to "Finally," "carefuly" to "carefully," "unnecessary" corrections, "posible" to "possible," and "whas" to "was." Additionally, minor grammar and wording adjustments were made for clarity throughout the document. The changes are documentation-only with no impact to code or public interfaces.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fixed typos' accurately summarizes the primary change in the changeset, which is correcting typographical errors in documentation files.
Linked Issues check ✅ Passed The PR addresses the objectives from issue #747: consolidated conflicting guidelines by removing .github/CONTRIBUTING.md and correcting typographical errors in CONTRIBUTING.md.
Out of Scope Changes check ✅ Passed All changes are within scope—removing the redundant .github/CONTRIBUTING.md file and fixing typos in CONTRIBUTING.md are both required by issue #747.
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
  • Post copyable unit tests in a comment

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: 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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a01b5d and 9747399.

📒 Files selected for processing (2)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.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.md has been completely removed as mentioned in the PR summary, to ensure there are no conflicting guidelines files remaining.

@tachyons
tachyons merged commit ac91c0a into CircuitVerse:master Jan 15, 2026
3 checks passed
@tachyons

Copy link
Copy Markdown
Member

Thanks @sengmonkham

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.

Contributing Guidelines and Fix Typos

2 participants