​​Merge Box Logic + Design

​​The goal of this doc: Map out existing states of the merge box, including logic and UI.

​​References

​​
​​

​​Overall components of merge box

​​Overview

​​
 
User-uploaded image: merge+box.png
​​
​​
​​
​​
​​

​​Review Status Section 

​​Overview

​​Deals with 1) reviewer section of sidebar and 2) these two sections in the merge box: 
​​
 
User-uploaded image: image.png
​​
​​Generally, if a PR has no review requirements, then there won't be explainer text in the sidebar. This section references the >1 required reviewers project: https://github.com/github/github/pull/86098#issuecomment-371277212

​​Approving Review States

​​
​​Here are the various states and how the sidebar and merge box relate to each other ​👇​ 
​​
​​States when there are unfulfilled review requirements: 
​​
​​
 
User-uploaded image: image.png
​​Left: sidebar - open, no suggestions, required reviews
​​Right: sidebar - open, with suggestions, required reviews
User-uploaded image: 37116072-ef110ec0-2201-11e8-9aa3-6a1126459765.png
​​merge box
​​
​​
​​
​​Status when review requirements are met:
​​
​​
 
User-uploaded image: 37116130-2ce81658-2202-11e8-87e0-02ac600afbde.png
​​sidebar - required reviews, requirements met
User-uploaded image: 37116138-35cc6454-2202-11e8-822a-5e4da660af3c.png
​​Merge box
​​
​​
​​Required reviews is closed or merged (when PR had reviews)
​​
​​
 
User-uploaded image: 37116176-5c67042a-2202-11e8-9d73-0b8a8ae29757.png
​​sidebar - closed or merged
User-uploaded image: image.png
​​No merge box in this state - PR is merged/closed
​​
​​
​​Requested changes
​​
​​
 
User-uploaded image: 37116445-35631606-2203-11e8-8bd4-0f2fb7cda105.png
​​sidebar - requested changes
User-uploaded image: 37116380-fad777e8-2202-11e8-9b63-5eb35ab9dce8.png
​​Merge box
​​
​​
​​Partially approved (2 required, 1 approving is present)
​​
​​That's a great overview and looks pretty complete to me. One additional case: Partially approved, 2 required, 1 approving review is present. Then the hint will show up in the sidebar too since the review policy is not fulfilled.