rustc-dev-guide icon indicating copy to clipboard operation
rustc-dev-guide copied to clipboard

Difficult to find 'How to structure your PR'

Open jyn514 opened this issue 5 years ago • 2 comments

When I was looking for info about how to structure my PR, I checked out the "A typical contribution" section of the Guide to Rustc development book, because based on the available sections, that seemed the most likely. I wouldn't have thought to look in the Coding Conventions sections (I wouldn't consider a PR a piece of code is why I'm guessing)

Originally posted by @alex-griffiths in https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/Creating.20a.20pull.20request/near/207373580.

jyn514 avatar Aug 19 '20 12:08 jyn514

As an addition to this, while it might not be strictly necessary, or even within the scope of the dev-guide, perhaps it could be helpful to include a brief comment (or even a quick overview of the required commands) about why the "No merge commits" point is made.

For new contributors like myself, this wasn't immediately clear to me, and I'm sure it's the same for others.

alex-griffiths avatar Aug 19 '20 12:08 alex-griffiths

perhaps it could be helpful to include a brief comment (or even a quick overview of the required commands) about why the "No merge commits" point is made.

@alex-griffiths this was added as part of https://github.com/rust-lang/rustc-dev-guide/pull/890: https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy

jyn514 avatar Sep 30 '20 18:09 jyn514