diff options
| author | Yuki Okushi <huyuumi.dev@gmail.com> | 2020-10-11 03:19:05 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-11 03:19:05 +0900 |
| commit | 1b134430ef110f99f0a280c9cf604dd54275b543 (patch) | |
| tree | e36a1a0ae5a44d67f4554f8e7196eeb7bdf03e0b /src/test/codegen/src-hash-algorithm/src-hash-algorithm-md5.rs | |
| parent | 87b71ed68b69361ab0d45653a972ad4cf7a65cba (diff) | |
| parent | e4943ac81163db364bd8c8ad1ea9c65b4adabcd3 (diff) | |
| download | rust-1b134430ef110f99f0a280c9cf604dd54275b543.tar.gz rust-1b134430ef110f99f0a280c9cf604dd54275b543.zip | |
Rollup merge of #77195 - follower:patch-2, r=jyn514
Link to documentation-specific guidelines.
Changed contribution information URL because it's not obvious how to get from the current URL to the documentation-specific content.
The current URL points to this "Getting Started" page, which contains nothing specific about documentation[*] and instead launches into how to *build* `rustc` which is not a strict prerequisite for contributing documentation fixes:
* https://rustc-dev-guide.rust-lang.org/getting-started.html
[*] The most specific content is a "Writing documentation" bullet point which is not itself a link to anything (I guess a patch for that might be helpful too).
### Why?
Making this change will make it easier for people who wish to make small "drive by" documentation fixes (and read contribution guidelines ;) ) which I find are often how I start contributing to a project. (Exhibit A: https://github.com/rust-lang/rust/pull/77050 :) )
### Background
My impression is the change of content linked is an unintentional change due to a couple of other changes:
* Originally, the link pointed to `contributing.md` which started with a "table of contents" linking to each section. But the content in `contributing.md` was removed and replaced with a link to the "Getting Started" section here:
* https://github.com/rust-lang/rust/commit/3f6928f1f6eff367e6ddbfb63ebc5e568ffe0eb1#diff-6a3371457528722a734f3c51d9238c13L1
But the changed link doesn't actually point to the equivalent content, which is now located here:
* https://rustc-dev-guide.rust-lang.org/contributing.html
(If the "Guide to Rustc Development" is now considered the canonical location of "How to Contribute" content it might be a good idea to merge some of the "Contributing" Introduction section into the "Getting Started" section.)
* This was then compounded by changing the link from `contributing.md` to `contributing.html` here:
* https://github.com/rust-lang/rust/pull/74037/files#diff-242481015141f373dcb178e93cffa850L88
In order to even find the new location of the previous `contributing.md` content I ended up needing to do a GitHub search of the `rust-lang` org for the phrase "Documentation improvements are very welcome". :D
Diffstat (limited to 'src/test/codegen/src-hash-algorithm/src-hash-algorithm-md5.rs')
0 files changed, 0 insertions, 0 deletions
