Skip to content
This repository was archived by the owner on Dec 15, 2022. It is now read-only.

Commit 11fb558

Browse files
smashwilsonvanessayuennkuychaco
committed
Describe the review summary panel within the "Files Changed" tab
Co-Authored-By: Vanessa Yuen <[email protected]> Co-Authored-By: Katrina Uychaco <[email protected]>
1 parent 3bc411e commit 11fb558

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/feature-requests/003-pull-request-review.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,24 @@ When the pull request is checked out, an "open" button is shown in the review fo
6161

6262
Clicking on the "Files Changed" tab displays the full, multi-file diff associated with the pull request. This is akin to the "Files changed" tab on dotcom.
6363

64+
> TODO: Change "Show review comments" checkbox to an expand/collapse review summaries control
65+
6466
![files](https://user-images.githubusercontent.com/378023/46536560-d3bb4200-c8e9-11e8-9764-dca0b84245cf.png)
6567

66-
* Diffs are editable.
67-
* Editing the diff is _only_ possible if the pull request branch is checked out and the local branch history has not diverged from the remote branch history.
68+
Clicking on the "Expand review summaries" control in the filter bar reveals an inline panel that displays the summary of each review created on this pull request, including the review's author, the review's current state, its summary comment, and a progress bar showing how many of the review comments associated with this review have been marked as resolved.
69+
70+
> TODO: Illustrate the "review summary" list panel
71+
72+
Clicking the checkbox within each review summary block hides or reveals the review summary comments associated with that review in diff on this tab. Clicking the "Collapse review summaries" control conceals the review summary panel again.
73+
74+
Beneath the review summary panel is the pull request's combined diff. Diffs are editable, but _only_ if the pull request branch is checked out and the local branch history has not diverged incompatibly from the remote branch history.
75+
76+
For large diffs, the files can be collapsed to get a better overview.
6877

6978
Uncollapsed (default) | Collapsed
7079
--- | ---
7180
![files](https://user-images.githubusercontent.com/378023/46536560-d3bb4200-c8e9-11e8-9764-dca0b84245cf.png) | ![collapsed files](https://user-images.githubusercontent.com/378023/46931273-7069a680-d085-11e8-9ea7-c96a1772fe27.png)
7281

73-
* For large diffs, the files can be collapsed to get a better overview.
74-
7582
#### Create a new review
7683

7784
##### `+` Button

0 commit comments

Comments
 (0)