PR Review Feature Request: review comment changes #1897
Conversation
Co-Authored-By: Vanessa Yuen <[email protected]> Co-Authored-By: Katrina Uychaco <[email protected]>
Co-Authored-By: Vanessa Yuen <[email protected]> Co-Authored-By: Katrina Uychaco <[email protected]>
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Codecov Report
@@ Coverage Diff @@
## master #1897 +/- ##
==========================================
- Coverage 91.05% 91.02% -0.03%
==========================================
Files 185 185
Lines 10719 10719
Branches 1575 1575
==========================================
- Hits 9760 9757 -3
- Misses 959 962 +3
Continue to review full report at Codecov.
|
with progress bars
Plus remove outdated mockups
|
As an update on our progress here:
|
|
At some point we have to decide how reviews and review comments should be sorted. To get a feel for it, there are two prototypes for the "first level" of sorting:
There are cons and pros for both and it maybe comes down to personal preference, but something I just realized now: When writing a review, the reviewer might talk about the previously made comment. If the comments get sorted by file, they may appear in a different order as they have been written and then it may not make sense if they say something like "same as above". See this example:
Therefore I think as a default, showing review comments in the same order how they got written makes the most sense. |
|
I'd like to suggest how I would personally prefer to see the reviews in Atom. For me, there are two types of review comments (not sure how they are named here):
To address the problem with some review comments being shown in weird order, I think the ideal solution would be to sort the files in the same way they are sorted on Github.com. Then the comments can be grouped by file and sorted by time of creation and still they would appear in the same way as they appear on Github.com . This, however, requires that the overall review comments be shown separately, maybe on top of the review comments, in their own section maybe. 🤔 |
I like this suggestion a lot! ✨ |
That’s a great suggestion. 👍 I just realized that the
In the "this is a really long name" example, it's nice that the other related comments are following right after so you can address them at the same time. Too much of an edge case? If so, we could implement "sorted by files" first and maybe add an option to sort by review later. |
|
Could we implement per-review filtering in Also of these two options I'm 👍 on |
I believe you almost always want to see all review comments at once for any given file, for several reasons:
Therefore, I think that that seeing review comments from multiple reviewers for a given file is almost always preferred to seeing only specific people's comments. If the concern is "seeing too many comments at once" then I feel the ability to collapse review comments of other files/seeing only review comments for a single file at once would provide enough visual clarity & focus.
|
Here review summaries with checkboxes that lets you hide review comments from other reviews:
Hmmm.. 🤔 That would work, but feels a bit complex? Showing avatar and time for collapsed headers could already be enough to see which review comments "belong together"?
The last review comment ☝️ is not part of any review because it's a "single comment", but I think that doesn't really matter. I often make a review and then after submitting the review, make more single comments that should be "part" of the review. 🤷♂️ |
| ### Files (tab) | ||
|
|
||
| Clicking on the "Files" tab displays the full, multi-file diff associated with the pull request. This is akin to the "Files changed" tab on dotcom. | ||
| ### Files Changed (tab) |
There was a problem hiding this comment.
I think we actually did call it "Files"
| @@ -186,6 +201,14 @@ It was a great improvement, but filtering the diff with radio buttons and checkb | |||
| - Keep using an editable editor for the diffs, but add some padding. | |||
| - Introduce a "Reviews" footer to all sub-views to allow creating/submit a review, no matter where you are. | |||
|
|
|||
| #### Third iteration | |||
There was a problem hiding this comment.
this is actually our third iteration, right? I'm not like imagining things?
|
Merging so the implementation PR #1995 has somewhere up-to-date to point 🎉 |
In our sprint planning meeting today, @vanessayuenn and @kuychaco had a number of ideas for how we could handle:
PullRequestDetailItemfeels redundant and "dotcom-y".@vanessayuenn, @kuychaco: Please correct me if I've misrepresented what you were going for, or if you've changed your minds about anything since the ideas have had a chance to percolate somewhat 😄
cc @simurai, because this is some of the stuff we'd like to run by you in our design meeting tonight 😇
✨ Prototype:
prototypes/1897-reviewsbranch ✨ Usegithub:open-mockcommand to see the "Reviews dock" item.View rendered docs/feature-requests/003-pull-request-review.md