-
Notifications
You must be signed in to change notification settings - Fork 6
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
MB-15466-Update readme instructions #333
Conversation
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 adding this! This has been information that has been passed along the grapevine for a while so it's nice to finally codify it.
Preface: For nits feel free to address the ones that you actually agree with. If you're on the fence you don't need to make the changes.
General nit: I think all of the headers should have an empty line after and code-block should have an empty line before and after. These seem to be fairly common suggestions across different markdown style guides. (If we really want to enforce these we should leverage automation and include it as part of the build process. Fwiw, your editor might have a pluggin that enables quick fixes for this. There are also cli tools for this. Eg. https://github.com/markdownlint/markdownlint and https://github.com/DavidAnson/markdownlint.)
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.
💖 This additional information is really useful, thank you for adding it!
The purpose of this PR is to add sections to the README about testing and updating the documentation so that it informs engineers who may need to make changes to the docs.