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

Improvements: Typos and grammatical errors in README.md #1081

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

IyaadDev
Copy link
Contributor

What kind of change does this PR introduce?

  • Fixed some typos, grammatical errors and added extra info in places for extra clarity

Issue Number:

If relevant, did you update the documentation?

  • Minor updates to README.md

Summary

  • Quick fix for some grammatical errors, typos and improvements on some information

*Feel free to check if there's anything I've missed out on*

Fixed some typos, grammatical errors and added extra info in places for extra clarity
@IyaadDev IyaadDev requested a review from a team as a code owner October 28, 2024 11:11
Copy link

github-actions bot commented Oct 28, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 7a64e4f

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (718dab5) to head (7a64e4f).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1081   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          373       373           
  Branches        94        94           
=========================================
  Hits           373       373           

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

@IyaadDev
Copy link
Contributor Author

Ready to merge 👍
This pr just goes through the README.md though
There are plenty more of these grammatical issues around the documentation, will look over some of them and post an issue and pr on those too

@DhairyaMajmudar
Copy link
Member

Wow! Pretty quick, Thanks for the PR @IyaadDev... You can use this PR for pushing other changes too.

README.md Outdated Show resolved Hide resolved
@DhairyaMajmudar DhairyaMajmudar added the Hacktoberfest-accepted Pull requests accepted for Hacktoberfest'24 label Oct 28, 2024
Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com>
@IyaadDev
Copy link
Contributor Author

Later throughout the course of this week hopefully I'll be able to review the rest of the docs to suggest changes,
thanks @DhairyaMajmudar

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution. I left just 1 single comment.

Good changes!

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Comment on lines +73 to 76
<br />
<a href = "https://github.com/json-schema-org/website/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=json-schema-org/website"/>
</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this markdown, like on line 88?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should work?

[![Contributors](https://contrib.rocks/image?repo=json-schema-org/website)](https://github.com/json-schema-org/website/graphs/contributors)

Preview:
Contributors

IyaadDev and others added 3 commits November 11, 2024 16:40
Co-authored-by: Greg Dennis <gregsdennis@yahoo.com>
Co-authored-by: Greg Dennis <gregsdennis@yahoo.com>
Copy link
Contributor Author

@IyaadDev IyaadDev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

README.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest-accepted Pull requests accepted for Hacktoberfest'24
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Typos and grammatical errors in README.md
4 participants