Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md regarding documentation contributions #40803

Merged
merged 2 commits into from
Mar 25, 2017
Merged

Update CONTRIBUTING.md regarding documentation contributions #40803

merged 2 commits into from
Mar 25, 2017

Conversation

chordowl
Copy link
Contributor

Changed link to documentation issues from A-docs to T-doc as this has just been migrated.
Added a link to the documentation style guidelines in RFC 1574 (I've linked to Appendix A specifically since that's the combined version).

r? @steveklabnik

Changed link to documentation issues from A-docs to T-doc as this has just been migrated.
Added a link to the documentation style guidelines.
@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (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.

Copy link
Member

@steveklabnik steveklabnik left a comment

Choose a reason for hiding this comment

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

one tiny nit, and then r=me ❤️

CONTRIBUTING.md Outdated
@@ -311,9 +311,11 @@ To save @bors some work, and to get small changes through more quickly, when
the other rollup-eligible patches too, and they'll get tested and merged at
the same time.

To find documentation-related issues, sort by the [A-docs label][adocs].
To find documentation-related issues, sort by the [T-doc label][tdoc].
You can find documentation style guidelines in [RFC 1574][rfc1574].
Copy link
Member

Choose a reason for hiding this comment

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

Could you put a newline above this? Markdown means that this will be one paragraph, let's make it two 😄

@steveklabnik
Copy link
Member

@bors: r+ rollup

thanks so much!

@bors
Copy link
Contributor

bors commented Mar 24, 2017

📌 Commit 7643ccd has been approved by steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Mar 24, 2017
…klabnik

Update CONTRIBUTING.md regarding documentation contributions

Changed link to documentation issues from A-docs to T-doc as this has just been migrated.
Added a link to the documentation style guidelines in RFC 1574 (I've linked to [Appendix A][1] specifically since that's the combined version).

r? @steveklabnik

[1]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
bors added a commit that referenced this pull request Mar 24, 2017
Rollup of 8 pull requests

- Successful merges: #40567, #40602, #40636, #40739, #40756, #40790, #40794, #40803
- Failed merges:
@bors bors merged commit 7643ccd into rust-lang:master Mar 25, 2017
@chordowl chordowl deleted the contributing-docs branch March 25, 2017 11:54
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.

4 participants