doc: fix CONTRIBUTING link #6653
Merged
Conversation
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
Member
Author
|
Actually, I'm just going to fix the link and merge myself, will open a PR to bring back the shim Contributing.md |
aad063d to
b1475be
Compare
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The Problem
The Contributing link in the readme was pointing to
CONTRIBUTING.ymlin the.githubrepo not.md, and 404ing.The solution
The PR now just updates the link to be correct, no new shim file
The PR updates the readme link to a shimCONTRIBUTING.mdfile in the repo, which links out to the correct file in the .github repo. I prefer this for visibility, personally, but wont block on it being like this. We just want to ensure the link is correct at the end of the day.Context
I swapped from/blob/HEADto/blob/masterbecause Github UI will auto expand to the SHA when using the HEAD form. I don't want folks to copy that and save the URL, because that would mean their links will never see updates to the file. Folks can intentionally get the SHA link when and if they want it.Now I can't repro this
¯\_(ツ)_/¯