Skip to content

docs: improve README clarity for new contributors #9043

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ray-1129
Copy link

This PR improves the clarity and structure of the README.md file to assist new contributors and users.

Changes include:

  • Rewriting the introductory sentence for better tone
  • Clarifying Quick Start installation options
  • Improving code comment clarity
  • Rephrasing help instructions to sound more community-friendly

Refined several parts of the README.md to improve clarity and help new contributors:
- Reworded the introductory sentence
- Added clarification to the Quick Start section
- Improved CDN comment clarity
- Rephrased the Slack support line to enhance tone and professionalism
Copy link

welcome bot commented May 16, 2025

💖 Thanks for opening this pull request! 💖

Things that will help get your PR across the finish line:

  • Run npm run lint -- --errors locally to catch formatting errors earlier.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

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