Skip to content
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

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Conversation

chenyunda218
Copy link
Contributor

@chenyunda218 chenyunda218 commented Oct 22, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Typo

Summary by CodeRabbit

  • Documentation
    • Improved clarity and formatting of the contribution guidelines.
    • Corrected typographical errors in the "Issue Reporting" and "Test Your Change" sections.

Copy link

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes involve textual corrections and formatting adjustments to the .github/HOW_TO_CONTRIBUTE.md document. Errors in the "Issue Reporting" and "Test Your Change" sections were fixed, enhancing clarity and consistency in formatting. The content of the "Code of Conductor" section remains unchanged. Overall, the document retains its structure while improving readability.

Changes

File Path Change Summary
.github/HOW_TO_CONTRIBUTE.md Corrected typographical errors in "Issue Reporting" and "Test Your Change" sections; improved formatting for clarity.

Poem

In the garden where rabbits play,
We tidy up our guide today.
With words aligned and errors gone,
Our path to contribute goes on!
Hops of joy, we leap and cheer,
For clearer steps are finally here! 🐇✨


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a 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 conciseness

While 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

📥 Commits

Files that changed from the base of the PR and between 053f1c2 and 7fc332f.

📒 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 typo

The changes in the "Issue Reporting" section enhance the document's clarity and correctness:

  1. Added line break improves readability.
  2. Fixed typo from "Provite" to "Provide".
  3. 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 terminology

The change from "uint test" to "unit test" in the "Test Your Change" section is correct and necessary. This fix:

  1. Accurately represents the type of test being referred to.
  2. Eliminates potential confusion for contributors.
  3. 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)

@GuoLei1990 GuoLei1990 changed the title fix: typo of HOW_TO_CONTRIBUTE.md Fix typo of HOW_TO_CONTRIBUTE.md Oct 25, 2024
@GuoLei1990 GuoLei1990 merged commit 2d22109 into galacean:main Oct 25, 2024
7 checks passed
Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.49%. Comparing base (91e5539) to head (c9b7912).
Report is 1 commits behind head on main.

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              
Flag Coverage Δ
unittests 69.49% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@coderabbitai coderabbitai bot mentioned this pull request Oct 31, 2024
3 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jan 7, 2025
3 tasks
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.

2 participants