development-guide icon indicating copy to clipboard operation
development-guide copied to clipboard

Decide guide policy for PRs that need to wait

Open hillaryj opened this issue 5 years ago • 3 comments

I've seen two major schools of thought on how to indicate that a PR that GitHub thinks is ready to merge actually needs to wait. This status is different than draft PRs because the code is ready to be reviewed/merged but may need other PRs to be completed before merging can be done, i.e. for coordinating a new feature across several repositories.

  1. Preface the title with [HOLD] or another keyword
  2. Include a label i.e. DO NOT MERGE or with the feature i.e. HOLD: COOL FEATURE or (preferably for standardizing) use the blocked label

Since we want to standardize repository labels in https://github.com/cisagov/.github/issues/7, I'm recommending we adopt the title-preface method. We'll incorporate the results of discussion here into the team guide.

hillaryj avatar Nov 18 '20 16:11 hillaryj

I do like having a label for this, mainly because it catches my eye when I look at the list of PR reviewers (something I do just prior to merging), but I'm sure I could get used to the title-preface method also.

dav3r avatar Nov 18 '20 18:11 dav3r

We could always do both - [HOLD] in the title and blocked as a label, perhaps?

hillaryj avatar Nov 18 '20 18:11 hillaryj

I suggest the title thang, and possibly applying the blocked label as well. This is an out of the ordinary circumstance, so having two ways to flag such PRs will help prevent mistakes without being burdensome.

jsf9k avatar Nov 18 '20 18:11 jsf9k