Updates to the contributing docs #37133
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
The CONTRIBUTING.md is hidden inside .github, because that's where it needs to be for GitHub to find it. But it contains useful information people might look for in the docs too, so symlink it from the doc directory.
Update a few aspects of this file which had become out of date. Link to the DEVELOPER_FAQ.md from the FAQ section at the end.
Not sure how it was ever in the top-level directory.
ZhilkinSerg
added
<Documentation>
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.
Summary
SUMMARY: None
Purpose of change
The contributing docs were out of date and hard to find.
Describe the solution
Symlink from
docto theCONTRIBUTING.mdwhich was otherwise hidden in.githubwhere people might struggle to find it.Update some out-of-date info in
CONTRIBUTING.md.Move
GUIDE_COMESTIBLES.mdinto doc (from the top-level directory; not sure how it ended up there in the first place).