Skip to content
This repository was archived by the owner on Sep 30, 2020. It is now read-only.

RWIB Mission 3 Contributing Page #199

Closed
wants to merge 4 commits into from
Closed

RWIB Mission 3 Contributing Page #199

wants to merge 4 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Oct 17, 2015

This is an adaptation of ncamerons page.

Todo:

  • It should have a link to instructions on submitting bug reports.
  • It should lead people to instructions for getting involved in RFC process.
  • It should provide leads for getting involved in evangelism.
  • It might highlight major initiatives, like IDE's. Such initiatives would need
    stable landing pages to link to, like internals threads or GitHub issues.

@rust-highfive
Copy link

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

@alexcrichton
Copy link
Member

r? @brson

@rust-highfive rust-highfive assigned brson and unassigned alexcrichton Oct 18, 2015
@brson
Copy link
Contributor

brson commented Oct 19, 2015

Thanks @EFindlay. I'll review Tuesday.

@brson
Copy link
Contributor

brson commented Oct 21, 2015

Just dropping this link real quick: https://dxr.mozilla.org/rust/source/

DXR is supposedly pretty stable and quite useful, so we need to give it exposure.

@brson
Copy link
Contributor

brson commented Oct 21, 2015

I've pushed PRS #201 (community), #200 (docs), and #199 (contributing) to my own gh pages so reviewers can see. The first goal is to get the community page merged since it's the most developed.

The key pages under review are community.html, user_groups.html, documentation.html, and contributions.html

@Manishearth
Copy link
Member

IMO this should be somehow linked on the first page too.

If you're learning Rust, you've no doubt been amazed at how awesome
the language is and will be keen to write more Rust code. Hopefully,
you'll also want to make a meaningful contribution to the community.
If you're not sure how best to do that, then hopefully this page will
Copy link
Member

Choose a reason for hiding this comment

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

nit: repeated hopefully.

@Manishearth
Copy link
Member

This looks great to me. I may be rearranging the stuff in this page when I add the other community libraries and other mentorship info, but for now it's pretty good.

@ashleygwilliams
Copy link
Member

hi! i think this is a great start to a contributing guide- however, it only answers 1 question: "what are the types of things i could work on"

it doesn't answer questions like

  • what needs most help
  • what is good for a first pr
  • how/what i need to do to contribute to a specific thing (proj deps etc)

an example i think of is: i want to contribute to docs. mentioning in this that docs are included in the rust repo itself, that they versioned, how that is affected by release cycles, etc would be all be super useful as they are important things to consider when deciding what and how to contribute.

perhaps this info should be in separate contributing.mds? but i would certainly link to them from here.

@ghost
Copy link
Author

ghost commented Oct 26, 2015

@ashleygwilliams Thanks for these good points. I'll make three new sections in contributing.md for each of these questions and get working on it.

@brson
Copy link
Contributor

brson commented Nov 3, 2015

I've posted a counter-PR against @EFindlay's branch. It doesn't do a lot new, but it does shuffle bits around: organizes the page into six sections that are listed up front with in-page links.

I was hoping this would be simplifying, but my rewritten section on 'bugs' is pretty sprawling. I'll give closer attention to all the other individual sections tomorrow.

Various changes to contributions.html
@brson
Copy link
Contributor

brson commented Nov 6, 2015

@EFindlay I've continued hacking at your version here. I've really gone crazy with it and overhauled the content from top to bottom to be more comprehensive and explanatory. Sorry for just jumping in and making the changes myself but it felt easier than trying to go back and forth on it.

@ghost
Copy link
Author

ghost commented Nov 8, 2015

No problem!

@ghost ghost closed this Nov 8, 2015
@brson brson mentioned this pull request Nov 30, 2015
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants