Writing mentored issues

[davidtwco]

Not sure if this is the right fit for this book, it relates more to the process of contributing rather than the technical details. Would it be useful to have a section in the guide for writing mentored issues?

The intention being that experienced contributors who are just getting started writing mentored issues would be able to review it and structure their mentoring instructions in as helpful and useful a way as possible and that the quality of the instruction would then be consistent?

It would contain things that mentors have found beneficial to include in mentoring instuctions; or things those that have done some mentored issues found useful or not so useful; examples of good and bad instruction?

Edit: only just now noticed that mentoring is mentioned in #25 so this might be a dupe.

[mark-i-m]

👍 I think it's a great idea. We can leave it open.

[nikomatsakis]

That's a great idea yes

[mark-i-m]

@nikomatsakis Would you be able to write this or suggest someone else to write it? Unfortunately, by construction this chapter requires people who are in high demand.

[mark-i-m]

Triaged: @davidtwco we were wondering if you had any thoughts you would like to write up? Otherwise, our current direction seems to be moving procedures to the forge....

[davidtwco]

@mark-i-m I can’t think of anything that I’d write up at the moment - I submitted this issue so long ago that whatever details I was thinking of at the time have subsequently vanished.

I think the forge would be a good fit for this given what you’ve said.

[nikomatsakis]

I could try to write something here maybe. I have a few thoughts.

[nikomatsakis]

Key points would be:

• You don't have to spell out every detail -- in fact, maybe it's better if you don't
• The main thing people need is (a) the high-level intent, (b) some pointers into the code so they know where to get started, and (ideally) (c) some links into the rustc-dev-guide
• And of course follow-up with questions. It's a good idea to make explicit the best way for people to contact you. Privmsg is often easiest but whenever possible it's good to move the conversation public or at least leave summaries, lest the person winds up not finishing, so that you have a record.
• Linking to the rustc rustdoc I (personally) think is also good, in part so that people learn it exists :)