Repository navigation
Say where a change to an external repository should go - #3072
Closed
isHeSatoshi wants to merge 1 commit into
Closed
isHeSatoshi wants to merge 1 commit into
isHeSatoshi wants to merge 1 commit into
Conversation
The "External Dependencies" pointer in contributing.md did not hint that it was about code copied into rust-lang/rust from another repository, and the page it leads to answered "where should I send this change?" only in a paragraph buried after the list of tools. Reword the pointer to name what it is about, and give the page a section up front that answers the question: enhancements and bug fixes go to the tool's own repository, a change that needs both a compiler change and a tool change goes in one rust-lang/rust pull request, and a fix for a tool that your compiler change breaks goes in that same pull request.
This comment was marked as low quality.
This comment was marked as low quality.
Collaborator
|
Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using |
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 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.
Fixes #1672.
The issue reports two problems:
contributing.mddoes not suggest that it means "things we have embedded in our repository but should be treated as external dependencies".This addresses both:
external-repos.mdgets a## Where should a change go?section near the top, before the mechanisms are described, stating the three cases.The three cases are the ones the page already states further down, moved up and stated plainly rather than invented:
rust-lang/rustpull request;The rest of the chapter is about the sync mechanisms, so the new section says so and gets out of the way.
No new links are added.