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

Rewrite readme #19

Merged
merged 3 commits into from
Jun 16, 2023
Merged

Rewrite readme #19

merged 3 commits into from
Jun 16, 2023

Conversation

HonkingGoose
Copy link
Contributor

Changes:

  • Use simple words and phrases
  • Use lists
  • Use GitHub's beta markdown admonitions (note message)
  • One sentence per line pattern

Context:

Rewrite to make the readme easier and quicker to read.

@HonkingGoose HonkingGoose requested a review from a team as a code owner June 16, 2023 11:56
@accessibility-bot
Copy link
Collaborator

👋 Hello and thanks for pinging us! You've entered our first responder queue. An accessibility first responder will review this soon.

  • 💻 On PRs for our review: please provide a review environment with steps to validate, screenshots (with alt text), or videos demonstrating functionality we should be checking. This will help speed up our review and feedback cycle.
  • ⚠️ If this is urgent, please visit us in #accessibility on Slack and tag the first responder(s) listed in the channel topic.

@HonkingGoose
Copy link
Contributor Author

Question for the maintainers of this repository: is the accesibility-bot meant to run on the open sourced version of this repository? It's linking to a first responder queue that I can't access. I guess the Slack channel link is not meant for me either.

@khiga8
Copy link
Contributor

khiga8 commented Jun 16, 2023

is the accesibility-bot meant to run on the open sourced version of this repository?

Hey @HonkingGoose, thank you for catching this! We've gone ahead and turned this automation off for this repo.

Copy link
Contributor

@khiga8 khiga8 left a comment

Choose a reason for hiding this comment

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

This is great! Thank you for improving the readability of this README! ✨

@khiga8 khiga8 merged commit aae72e9 into github:main Jun 16, 2023
@HonkingGoose HonkingGoose deleted the docs/readme branch June 16, 2023 19:49
@HonkingGoose
Copy link
Contributor Author

Thank you for turning off the bot, and for merging my work. 😄

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.

3 participants