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

Update README.md #1

Merged
merged 1 commit into from
Oct 29, 2023
Merged

Update README.md #1

merged 1 commit into from
Oct 29, 2023

Conversation

samarthsarvade
Copy link
Owner


Formatting Issues Fixed: I fixed formatting issues where there were extra asterisks at the beginning and end of the "Contribution Guidelines" section. The guidelines now appear as a markdown table properly.

Consistent Alignment: I ensured that headings and text are consistently aligned, which improves the overall readability of the README.

Improved Section Headers: I replaced

tags with markdown headers (#) for consistency, and I made section headers more prominent.

Added Links: I ensured that all links are properly formatted and working. This includes links to external websites, contribution guidelines, and more.

Tech Stack Section: I formatted the "Tech Stack Used" section to display technology badges more clearly and consistently.

Contributors Section: I added a note to acknowledge and thank contributors for their contributions.

Clarified Mentors/Maintainers: I provided more clarity on the role of project mentors/maintainers.

Overall Readability: The improved formatting and alignment make the README more visually appealing and easier to read.

These changes enhance the overall presentation and readability of the README, making it more informative and user-friendly for visitors to your GitHub repository.

Fixes Issue

Closes Spyware007#2069

Changes proposed

Screenshots

Screenshot (66)

Checklist

  • [✅ ] You've linked this PR to the correct issue.

  • [ ✅] You have checked that the code is working correctly.

  • [✅ ] You ⭐️ the repository!

Note to reviewers

es, PR Spyware007#2069 needs to be merged to before working, etc.). -->

Formatting Issues Fixed: I fixed formatting issues where there were extra asterisks at the beginning and end of the "Contribution Guidelines" section. The guidelines now appear as a markdown table properly.

Consistent Alignment: I ensured that headings and text are consistently aligned, which improves the overall readability of the README.

Improved Section Headers: I replaced <h1> tags with markdown headers (#) for consistency, and I made section headers more prominent.

Added Links: I ensured that all links are properly formatted and working. This includes links to external websites, contribution guidelines, and more.

Tech Stack Section: I formatted the "Tech Stack Used" section to display technology badges more clearly and consistently.

Contributors Section: I added a note to acknowledge and thank contributors for their contributions.

Clarified Mentors/Maintainers: I provided more clarity on the role of project mentors/maintainers.

Overall Readability: The improved formatting and alignment make the README more visually appealing and easier to read.

These changes enhance the overall presentation and readability of the README, making it more informative and user-friendly for visitors to your GitHub repository.
@samarthsarvade
Copy link
Owner Author

The proposed changes in the README include fixing formatting issues, improving alignment and visual consistency, verifying and enhancing links, and providing clear acknowledgments to contributors. These changes make the README more organized, informative, and user-friendly. We welcome your contribution to our project, and these improvements will help provide a better experience for contributors like you.

@samarthsarvade samarthsarvade merged commit f4df2d0 into main Oct 29, 2023
@samarthsarvade samarthsarvade deleted the samarthsarvade-patch-1 branch October 29, 2023 18:44
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.

[Add] Fix Readme
1 participant