Add new-style readme build badges, bump actions/checkout in README.md examples#188
Merged
jpogran merged 3 commits intohashicorp:mainfrom Sep 16, 2022
magnetikonline:readme-build-badge-toc
Merged
Add new-style readme build badges, bump actions/checkout in README.md examples#188jpogran merged 3 commits intohashicorp:mainfrom magnetikonline:readme-build-badge-toc
actions/checkout in README.md examples#188jpogran merged 3 commits intohashicorp:mainfrom
magnetikonline:readme-build-badge-toc
Conversation
jpogran
suggested changes
May 18, 2022
Contributor
jpogran
left a comment
There was a problem hiding this comment.
Thank you for the help with the documentation. This looks great with the exception of the TOC. Your project looks very useful in other contexts, but HashiCorp follows a general format for a README and we don't include a TOC in most cases. This README isn't long enough to warrant one and GitHub already creates anchors for all of the headers to link to.
Contributor
Author
jpogran
approved these changes
May 20, 2022
actions/checkout in README.md examples
jpogran
approved these changes
Sep 16, 2022
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some quality of life things in
README.md:Added TOC toREADME.mdgenerated with (self plug!) https://magnetikonline.github.io/markdown-toc-generate/