Skip to content

Improve README: fix typos, enhance links, and improve clarity #219

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

Merged
merged 1 commit into from
May 30, 2025

Conversation

hasnainmakada-99
Copy link
Owner

📇 Changes proposed

This PR improves the README.md file with several enhancements:

  • Fixed HTML typos: Corrected mismatched h1/h2 tags in the main title
  • Fixed spelling and grammar: Corrected "maitainers" to "maintainers" and added missing "to" in sentence
  • Enhanced file references: Updated links to use relative paths (./Contributors.md, ./LICENSE, ./how-to-add-resources.md) for better navigation
  • Improved Features section: Added bold headings and more engaging, descriptive language
  • Standardized Discord links: Ensured consistency across all Discord invite links

✅ Check List

  • My code follows the code style of this project.
  • This PR does not contain plagiarized content.
  • This PR contains changes in the documentation
  • This PR contains changes in the Code of the project
  • The title of my pull request is a short description of the requested changes.

📄 Note to reviewers

These changes improve the overall quality and user experience of the README without changing any functionality. All links have been tested to ensure they work correctly with relative paths.

📷 Screenshots

N/A - Text-only changes to README.md

- Fix mismatched HTML tags in h1 title
- Correct typos: 'maitainers' -> 'maintainers', add missing 'to'
- Update file references to use relative paths for better navigation
- Enhance Features section with bold headings and engaging language
- Standardize Discord invite links for consistency
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey! contributor, thank you for opening a Pull Request 🎉.

Soon one of our maintainers will review it and provide you with feedback/suggestions. If you think it's something urgent, feel free to reach out Hasnain Makada on Twitter. Star ⭐ this repo to show us support.

Happy, Open Source!

@hasnainmakada-99 hasnainmakada-99 marked this pull request as ready for review May 30, 2025 21:35
@hasnainmakada-99 hasnainmakada-99 merged commit 6250e93 into main May 30, 2025
3 checks passed
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