-
Notifications
You must be signed in to change notification settings - Fork 55
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
Docs improvements in README.md #137
Conversation
…tion that the final output is a GitHub issue.
I cannot add a label, as requested in the instructions. |
In order to Not sure if those two dependencies are missing from |
Thanks for catching this! |
I've got a pull request open to fix this. Another great find. Thanks for bringing it to my attention @spier! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Thanks for the fixes and improvements!! Really appreciate you taking the time to upstream these and help the next user that has to read these docs!
Documentation fixes in the main README.md.
Proposed Changes
*
footnotes are supposed to be formattedReadiness Checklist
Author/Contributor
make lint
and fix any issues that you have introducedmake test
and ensure you have test coverage for the lines you are introducingbug
,documentation
,enhancement
,infrastructure
, orbreaking