Skip to content

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

Open

Description

@jyn514

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.

Activity

  1. alex-griffiths commented on Aug 19, 2020

    @alex-griffiths

    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.

  2. added
    E-easyDifficulty: might be a good place for a beginner
    on Sep 30, 2020
  3. jyn514 commented on Sep 30, 2020

    @jyn514
    MemberAuthor

    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

  4. added
    A-metaArea: meta, about rustc or rustc-dev-guide itself
    T-compilerRelevant to the compiler team
    A-socialArea: social aspects
    E-hardDifficulty: might require advanced knowledge
    and removed
    E-easyDifficulty: might be a good place for a beginner
    on Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-contribution-workflowsArea: contribution workflowsA-metaArea: meta, about rustc or rustc-dev-guide itselfA-socialArea: social aspectsE-hardDifficulty: might require advanced knowledgeT-compilerRelevant to the compiler team

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions