Link to "Contributing to Rust" rather than "Getting Started". #77268
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
Change to link to "Contributing to Rust" chapter of `rustc` Dev Guide, primarily on the basis that the GitHub "first contribution" Issue "pop-up" says "Be sure to review the [contributing guidelines] and [code of conduct]" and links to this file. When/if the guide/"Getting Started" section gets revised to not be `rustc`-specific the linked section can be changed. In the meantime this prevents leading first time contributors into a confusing cul de sac.
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
pickfire
approved these changes
Sep 27, 2020
LeSeulArtichaut
approved these changes
Sep 28, 2020
|
r? @spastorino maybe? |
|
Yeah, I agree the "Getting Started" chapter title might look weird as a result but presumably that will need to be dealt with in a separate PR anyway, so this at least fixes it at this end. :) |
|
@bors r+ rollup I thought we already made this change? I'm confused ... but these changes look good. |
|
📌 Commit a7bd6c4 has been approved by |
bors
added
S-waiting-on-bors
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Oct 22, 2020
Link to "Contributing to Rust" rather than "Getting Started". Change to link to "Contributing to Rust" chapter of `rustc` Dev Guide, primarily on the basis that: * The GitHub "first contribution" Issue "pop-up" says "Be sure to review the [contributing guidelines] and [code of conduct]" and links to this file. * The "Bug Report" section _seems_ to restrict itself to if "a compiler error message [told] you to come here". * The previous content of `CONTRIBUTING.md` now lives in the "Contributing to Rust" chapter. When/if the guide/"Getting Started" section gets revised to not be `rustc`-specific, the choice of linked chapter could be updated. In the meantime this prevents leading first time contributors into a confusing cul de sac. _[I wasn't planning to make a PR for this until discussion in rust-lang#77215 concluded but the discovery that the "first issue" pop-up also links to this document IMO makes it a higher priority to make the link useful sooner rather than later.]_ Related issues: * rust-lang#77215 * rust-lang/rustc-dev-guide#775 (comment)
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 23, 2020
Rollup of 17 pull requests Successful merges: - rust-lang#77268 (Link to "Contributing to Rust" rather than "Getting Started".) - rust-lang#77339 (Implement TryFrom between NonZero types.) - rust-lang#77488 (Mark `repr128` as `incomplete_features`) - rust-lang#77890 (Fixing escaping to ensure generation of welformed json.) - rust-lang#77918 (Cleanup network tests) - rust-lang#77920 (Avoid extraneous space between visibility kw and ident for statics) - rust-lang#77969 (Doc formating consistency between slice sort and sort_unstable, and big O notation consistency) - rust-lang#78098 (Clean up and improve some docs) - rust-lang#78116 (Make inline const work in range patterns) - rust-lang#78153 (Sync LLVM submodule if it has been initialized) - rust-lang#78163 (Clean up lib docs) - rust-lang#78169 (Update cargo) - rust-lang#78231 (Make closures inherit the parent function's target features) - rust-lang#78235 (Explain where the closure return type was inferred) - rust-lang#78255 (Reduce diagram mess in 'match arms have incompatible types' error) - rust-lang#78263 (Add regression test of issue-77668) - rust-lang#78265 (Add some inference-related regression tests about incorrect diagnostics) Failed merges: r? `@ghost`
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.
Change to link to "Contributing to Rust" chapter of
rustcDev Guide, primarily on the basis that:The GitHub "first contribution" Issue "pop-up" says "Be sure to review the [contributing guidelines] and [code of conduct]" and links to this file.
The "Bug Report" section seems to restrict itself to if "a compiler error message [told] you to come here".
The previous content of
CONTRIBUTING.mdnow lives in the "Contributing to Rust" chapter.When/if the guide/"Getting Started" section gets revised to not be
rustc-specific, the choice of linked chapter could be updated.In the meantime this prevents leading first time contributors into a confusing cul de sac.
[I wasn't planning to make a PR for this until discussion in #77215 concluded but the discovery that the "first issue" pop-up also links to this document IMO makes it a higher priority to make the link useful sooner rather than later.]
Related issues:
Could CONTRIBUTING.md be improved? #77215
Make contributing.md into a series of tutorials rustc-dev-guide#775 (comment)