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

[EASY PR] Update README.md for spelling and grammar clarity #249

Merged
merged 3 commits into from
Jul 18, 2022

Conversation

Syed-Naufal-Mahmood
Copy link
Contributor

@Syed-Naufal-Mahmood Syed-Naufal-Mahmood commented Jul 16, 2022

  • Fix spelling errors
  • Change wording and sentence structure for clarity
  • Standardized capitalization of Devise, since it is capitalized in their documentation
  • Add table of contents to provide an overview of document and for quick traversal

* Fix spelling errors 
* Change wording and sentence structure for clarity
* Standardized capitalization of Devise, since it is capitalized in their documentation
Add a table of contents to provide an overview of the readme and quick traversal of the document
@waiting-for-dev
Copy link
Owner

Thanks! I appreciate it 🙂

I'm in favor of all the small changes, but I prefer not having to maintain a TOC. Remember that GH does that automatically (icon on the left of README.md):

Uploading screenshot-gh.neting.cc-2022.07.16-09_35_54.png…

@Syed-Naufal-Mahmood
Copy link
Contributor Author

Thanks for responding! I actually didn't know GH provides the TOC automatically, you learn something new everyday. I have added another commit that removes the TOC changes.

@waiting-for-dev waiting-for-dev merged commit 57464a3 into waiting-for-dev:master Jul 18, 2022
@waiting-for-dev
Copy link
Owner

Thanks, @Syed-Naufal-Mahmood!

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