Add CONTRIBUTING.md links #296
Merged
Conversation
This file contains 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
It causes 181 and 212 to not be automatically hyperlinked (at least in Chromium) and I can't find anything this is actually quoting anyway.
"Autolinked references are not created in wikis or files in a repository" https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls
I don't mind using inline-style links everywhere if people prefer, but I felt this style made reading the "To understand the reasoning behind these decisions, see..." section easier to read in raw markdown.
axelboc
added
the
chore
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I removed the ">" quote from "To understand the reasoning behind these decisions, see...", as I couldn't find anything this is actually quoting anyway.
I added links to all #XXX references. We see this is intentional according to https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls, which states, "Autolinked references are not created in wikis or files in a repository."
I unified all #XXX links to use reference-style links. I don't mind using inline-style links everywhere if people prefer, but I felt this style made reading the "To understand the reasoning behind these decisions, see..." section easier to read in raw markdown.