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

Conversation

@simurai
Copy link
Contributor

@simurai simurai commented Oct 5, 2018

This is a 3rd iteration on "Pull Request Reviews" in Atom.

Rendered
🚶‍♀️ Walkthrough 🚶
🏓 Static prototype 🦗

Summary of the changes:

  • Bring back the sub-navigation, but make it look less .com-y.
  • Keep using an editable editor for the diffs, but add some padding.
  • Introduce a "Reviews" footer to all sub-views to allow creating/submiting a review, no matter where you are.

History:

Version 2: #1706
Version 1: #1712

@simurai simurai added work-in-progress feature request Propose new features or design labels Oct 5, 2018
@coveralls
Copy link

coveralls commented Oct 5, 2018

Coverage Status

Coverage decreased (-0.02%) to 84.912% when pulling c73ed99 on sm/pr-review-rfc into 6fad892 on master.

Copy link
Contributor Author

@simurai simurai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two questions that came up...

  1. Now that "Suggested changes" got announced at Universe, should we already start thinking how to incorporate that in this RFC?
  2. If we do everything in this RFC at once, it would be a gigantic PR. How can we break it up into smaller implementation phases so that we can keep adding value with smaller ships?

@donokuda
Copy link

Now that "Suggested changes" got announced at Universe, should we already start thinking how to incorporate that in this RFC?

I think it makes sense to keep suggested changes out of this RFC so that the scope of work stays focused.

@simurai simurai mentioned this pull request Oct 20, 2018
Copy link
Contributor

@smashwilson smashwilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm 👍 on these design changes, modulo a few comments for discussion 😄


Diffs are editable _only_ if the pull request branch is checked out and the local branch history has not diverged from the remote branch history.
- Overview
- Files (**new**)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we still want Files to be the default tab, to feel more "editor-y"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Although then we probably should rename "Overview" to "Conversation" or similar.

##### `+` Button

Clicking "none" hides all comments, in the event that users want to see diff information only.
Hovering along the gutter within a pull request diff region in a `TextEditor` or a `PullRequestDetailItem` reveals a `+` icon. Clicking the `+` icon reveals a new comment box, which may be used to submit a single comment or start a multi-comment review:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can only create new review comments at certain locations within the files, though: it has to be within a diff region on the PR. Can we add some kind of gutter decoration to signal where these regions are?

@simurai
Copy link
Contributor Author

simurai commented Oct 30, 2018

Just adding @kuychaco's point from the design review before I forget it:

Have a way to only show files and diffs that contain a review comment.

Example:

  • file.a
    • line 23
      • comment A (with replies)
      • comment B (with replies)
      • comment C (with replies)
    • line 82
      • comment A (with replies)
      • comment B (with replies)
  • file.b
    • line 147
      • comment A (with replies)
    • line 264
      • comment A (with replies)
      • comment B (with replies)

@smashwilson
Copy link
Contributor

@simurai How would you feel about merging this as-is? It's a bit confusing to have the currently-definitive form of this feature request here instead of in docs/feature-requests 😅

@simurai
Copy link
Contributor Author

simurai commented Nov 13, 2018

Sure. 👍

I guess we can make an exception here and not wait until it's shipped. This one is more like a "longer term" RFC.

@simurai simurai merged commit 33b9063 into master Nov 13, 2018
@simurai simurai deleted the sm/pr-review-rfc branch November 13, 2018 22:24
@smashwilson
Copy link
Contributor

I guess we can make an exception here and not wait until it's shipped. This one is more like a "longer term" RFC.

It's less that and more that we already merged a version of it, so it feels like we should keep that as the "canon" version we're shooting for. Feature requests we create from this point on will follow the "keep the PR open" style (until we change our minds about it I guess).

@vanessayuenn vanessayuenn mentioned this pull request Nov 21, 2018
5 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation feature request Propose new features or design

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants