Skip to content

Add contribution instructions to stdlib docs#40765

Merged
bors merged 4 commits into
rust-lang:masterfrom
pirate:patch-3
Apr 12, 2017
Merged

Add contribution instructions to stdlib docs#40765
bors merged 4 commits into
rust-lang:masterfrom
pirate:patch-3

Conversation

@pirate

@pirate pirate commented Mar 23, 2017

Copy link
Copy Markdown
Contributor

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!

@rust-highfive

Copy link
Copy Markdown
Contributor

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.

@steveklabnik

Copy link
Copy Markdown
Contributor

This should probably link to https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md

@pirate

pirate commented Mar 23, 2017

Copy link
Copy Markdown
Contributor Author

@steveklabnik added a link to the guidelines, also mentioned the #rust IRC channel and changed some wording.

@aturon aturon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of nits.

Comment thread 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to suggest #rust-docs instead?

Comment thread 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).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bunch of the source lives in libcore, liballoc, libcollections, should probably include pointers there as well.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to link to all the various source repos, or shall I just link to https://github.com/rust-lang instead?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think just linking to the main repo is a good idea.

@alexcrichton

Copy link
Copy Markdown
Member

bors: r=aturon

@alexcrichton

Copy link
Copy Markdown
Member

@bors: r=aturon

@bors

bors commented Apr 11, 2017

Copy link
Copy Markdown
Collaborator

📌 Commit 9765fbc has been approved by aturon

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Apr 12, 2017
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!
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Apr 12, 2017
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!
@bors

bors commented Apr 12, 2017

Copy link
Copy Markdown
Collaborator

⌛ Testing commit 9765fbc with merge 1dca19a...

bors added a commit that referenced this pull request Apr 12, 2017
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!
@bors

bors commented Apr 12, 2017

Copy link
Copy Markdown
Collaborator

☀️ Test successful - status-appveyor, status-travis
Approved by: aturon
Pushing 1dca19a to master...

@bors bors merged commit 9765fbc into rust-lang:master Apr 12, 2017
@pirate pirate deleted the patch-3 branch April 12, 2017 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants