AlexsLemonade / refinebio-examples

Example workflows for refine.bio data

Home Page:https://www.refine.bio

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Make a PR template for "hotfixes"

cansavvy opened this issue · comments

Background

In the discussion about the PR process in #313, @jashpiro noted we should make sure that hotfix PRs, which should involve two PRs, one to master and secondly one to staging should note the master PR so we know they've been reviewed and the process can be expedited. @jaclyn-taroni mentioned this would be a good place for a separate PR template (separate from #322).

Problem

hotfix PRs will involve the same change made to two branches: staging and master. We don't want this to increase reviewer burden aka in-depth review of the same essential change twice.

What are the recommended next steps?

The hotfix PR template should remind the person who files it to mention if this change has been reviewed on another PR and link to it. This was the second PR to staging can go by more quickly.

I don't think this means we need two PR templates for hotfixes, just one template that has a prompt that encourages the user to mention a previous PR if applicable.

This template should also include other basics like "strategy" and "problem" and perhaps other items I'm not aware of at this time but we might figure out when we try to do our first "hotfix".

Maybe the second hotfix to staging PR should include a quick blurb about what conflicts were encountered and how they were handled. That will be the main thing reviewed for in hotfix to staging PRs and not so much the change itself since that will have been reviewed already.