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

Add advice about submitting potentially hard-to-review PRs

Open jieyouxu opened this issue 1 year ago • 1 comments

Prior discussion: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Expert.20map.20and.20suitable.20reviewer.20maps.3F/near/456305821.

Some context (partial summary of the prior discussion): I've noticed that we have had quite a few cases of the spin-the-bottle or pass-the-hot-potato review assignment reroll game (at least for the compiler reviewers) because some PRs might be very hard to review (due to being massive/complex/cross-cutting/highly domain specific etc.).

So in this PR, we add some advice for contributors about making potentially hard-to-review PRs (those that are large, complex, cross-cutting and/or highly domain-specific) to:

  • Talk with t-compiler before submitting a very difficult to review PR
  • Work with t-compiler to break down a large unreviewable PR into smaller, more reviewable PRs

cc @wesleywiser and @davidtwco compiler team leads for a vibe check and wording feedback, and if we want to make this advice at all.

jieyouxu avatar Aug 05 '24 06:08 jieyouxu

(Seems like PR CI has a bunch of pre-existing link check errors)

jieyouxu avatar Aug 05 '24 07:08 jieyouxu

(Contains no changes, just rebased to overcome CI failure)

jieyouxu avatar Sep 23 '24 08:09 jieyouxu