Add contribution instructions to stdlib docs #40765
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aturon (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
|
This should probably link to https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md |
|
@steveklabnik added a link to the guidelines, also mentioned the #rust IRC channel and changed some wording. |
src/libstd/lib.rs
Outdated
| //! pull-requests for your suggested changes. | ||
| //! | ||
| //! Contributions are appreciated! If you see a part of the docs that can be | ||
| //! improved, submit a PR, or chat with us first on irc.mozilla.org #rust. |
There was a problem hiding this comment.
Might want to suggest #rust-docs instead?
src/libstd/lib.rs
Outdated
| //! # Contributing changes to the documentation | ||
| //! | ||
| //! Check out the rust contribution guidelines [here](https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md). | ||
| //! The source for this documentation can be found on [Github](https://github.com/rust-lang/rust/tree/master/src/libstd). |
There was a problem hiding this comment.
A bunch of the source lives in libcore, liballoc, libcollections, should probably include pointers there as well.
There was a problem hiding this comment.
Do we want to link to all the various source repos, or shall I just link to https://github.com/rust-lang instead?
There was a problem hiding this comment.
I think just linking to the main repo is a good idea.
|
bors: r=aturon |
|
@bors: r=aturon |
|
📌 Commit 9765fbc has been approved by |
Add contribution instructions to stdlib docs Generally programming language docs have instructions on how to contribute changes. I couldn't find any in the rust docs, so I figured I'd add an instructions section, let me know if this belongs somewhere else!
Add contribution instructions to stdlib docs Generally programming language docs have instructions on how to contribute changes. I couldn't find any in the rust docs, so I figured I'd add an instructions section, let me know if this belongs somewhere else!
Add contribution instructions to stdlib docs Generally programming language docs have instructions on how to contribute changes. I couldn't find any in the rust docs, so I figured I'd add an instructions section, let me know if this belongs somewhere else!
|
☀️ Test successful - status-appveyor, status-travis |
Generally programming language docs have instructions on how to contribute changes.
I couldn't find any in the rust docs, so I figured I'd add an instructions section, let me know if this belongs somewhere else!