Skip to content

Difficult to find 'How to structure your PR' #831

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

Open
jyn514 opened this issue Aug 19, 2020 · 2 comments
Open

Difficult to find 'How to structure your PR' #831

jyn514 opened this issue Aug 19, 2020 · 2 comments
Labels
A-contribution-workflows Area: contribution workflows A-meta Area: meta, about rustc or rustc-dev-guide itself A-social Area: social aspects E-hard Difficulty: might require advanced knowledge T-compiler Relevant to compiler team

Comments

@jyn514
Copy link
Member

jyn514 commented Aug 19, 2020

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.

@alex-griffiths
Copy link

alex-griffiths commented Aug 19, 2020

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.

@jyn514 jyn514 added the E-easy Difficulty: might be a good place for a beginner label Sep 30, 2020
@jyn514
Copy link
Member Author

jyn514 commented Sep 30, 2020

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 #890: https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy

@jieyouxu jieyouxu added A-meta Area: meta, about rustc or rustc-dev-guide itself T-compiler Relevant to compiler team A-social Area: social aspects A-contribution-workflows Area: contribution workflows E-hard Difficulty: might require advanced knowledge and removed E-easy Difficulty: might be a good place for a beginner labels Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-contribution-workflows Area: contribution workflows A-meta Area: meta, about rustc or rustc-dev-guide itself A-social Area: social aspects E-hard Difficulty: might require advanced knowledge T-compiler Relevant to compiler team
Projects
None yet
Development

No branches or pull requests

3 participants