Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
RFC for Pull Request Review #1706
I've started to collect the design work that @simurai, myself, and others have been collaborating on off and on over the past few months into a single document about the pull request review experience we want to support in Atom. I'm hopeful that by putting it all in one place, we can have a clearer picture about the pieces we'll need to put in place to make it a reality.
This is highly WIP - I literally just through up a few paragraphs the other day. I'm pushing it now so that all of you can see how far along I am
Okay, I think the prose here is in a state that accurately represents the contents of my head about this. I drew pretty heavily from our existing work (and used @simurai's existing excellent design graphics!) but I've also tried to "fill in the gaps" as I went.
Specifically, I've added:
And I've omitted for now:
Next, I'm going to try to do some UI mocks for the missing diagrams so you don't have to puzzle out when I mean from the text alone for the new bits. But I think this is far enough along that others could help me with reviews that:
Once we're satisfied with the state of the vision described here, we can fill out the "implementation phases" list and figure out the best places to get started
I updated a bunch of mockups, but not quite sure about the difference between "Changes" and "Reviews" tab. I guess they are for:
- Changes tabs are for reviewers. In order to review a PR, they need to see the whole diff.
- Reviews tab are for PR authors. A place with all reviews to respond to.
I guess that separation is nice, but maybe also confusing? Like you click on Reviews but not realizing that some of the changes (diff) are missing. Anyways, I'll sleep over it.
I believe both "Changes" and "Reviews" tabs provide distinct value for both scenarios. Here's the bit from the Alternative section:
I'll also note that the "Changes" tab as written doesn't give us an easy way to show the summary comments and
Dotcom basically mixes the "Reviews" tab into the PR timeline, and puts the checklist/progress bit in the box at the top:
This was referenced
Oct 2, 2018
I think we're all on the same page in terms of our rough design direction and scope for this work
Thank you everyone for weighing in and hashing this out together. Coming to consensus on something like this is really challenging and there's a super long trail of fine details that we'll hash out as we're building it. But it's already really really improved from the write-up I started at the beginning of this week, when it was just an expression of what was in my head.