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

Revise README.md for Consistency and Useability #493

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

bboonstra
Copy link

Summary

This PR cleans up the README.md for accessibility, readability, and standardization.

  • Corrects invalid html
  • Removes dead links and adds new anchors
  • Standardizes some markdown
  • Aligns bullets, rows, columns, etc

Description

The current README gets the job done. However, it's quite messy when you try to edit it, it doesn't follow the markdown standards, has dead links/anchors, and there's an invalid paragraph closing tag (<p/>) at the top! I thought that, before I submitted a solution, it would be helpful to future contributors to have a cleaner README to edit.

How Has This Been Tested?

  • The new README has been checked against the old one and is consistent when rendered.

Make sure all below guidelines are followed else PR will get rejected:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code so that it is easy to understand
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

Copy link

welcome bot commented Oct 13, 2024

I can tell this is your first pull request! Thank you I'm so honored. 🎉🎉🎉 I'll take a look at it ASAP!

@bboonstra bboonstra changed the title Revise README.md Revise README.md for Consistency and Useability Oct 13, 2024
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.

1 participant