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

Commit a9ee940

Browse files
committed
add some draft about the overview of components
still thinking about how to structure the explanation
1 parent 781f088 commit a9ee940

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

docs/feature-requests/006-pull-request-reviewer-flow.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,51 @@ Provide code review to an existing pull request within Atom.
1414

1515
## :checkered_flag: Motivation
1616

17-
We already have a workflow built out for the receiving end of pull request reviews; it only makes sense to also build out a workflow for users to author pull request reviews.
17+
We already have an innovative review-comments-in-dock (RCID) workflow built out for the receiving end of pull request reviews. In order to complete the full experience of code review within Atom, we should also build out a workflow for users to author pull request reviews.
1818

1919
## 🤯 Explanation
2020

21+
### "All Reviews" tab
22+
This tab shows all review summaries and review comments, including the ones that are part of a _pending review_ that has not been submitted yet.
23+
24+
#### Header
25+
- When there is no pending review, button reads "Start a pending review", clicking on which will take you to the Pending Review tab in its empty state.
26+
- When there is already a pending review, the button reads "Resume review (2)". The number indicates the number of comments currently in the pending review. When adding more pending comments _within the All Reviews tab_, there should be some emphasis on the number changing -- akin to the button on dotcom. Clicking on this button takes user to the Pending Review tab.
27+
28+
29+
- rationale for scaling down the "Checkout" button
30+
- caveats of doing so
31+
- mitigation
32+
33+
#### Responding to a comment thread
34+
start a new review button
35+
36+
#### Pending comments
37+
38+
Pending comments within the All Reviews tab are styled differently from the already published comments. Pending comments contain a way to direct user to the Pending Review tab.
39+
40+
41+
42+
43+
### "Pending Review" tab
44+
This tab shows a *subset* of all reviews -- only the summary and comments of a pending review. Since a user is only allowed to have one pending review at a time, there should also only be one active Pending Review tab.
45+
46+
#### Header
47+
The header looks very similar to the one of All Reviews tab, with the exception that the primary button now reads "See all reviews", and will send users back to the All Reviews tab.
48+
49+
50+
#### Summary section
51+
52+
- sticky
53+
- drop down to select review type
54+
- button to submit review
55+
56+
#### Comments section
57+
58+
- empty state
2159

2260

23-
Explain the proposal as if it was already implemented in the GitHub package and you were describing it to an Atom user. That generally means:
2461

25-
- Introducing new named concepts.
26-
- Explaining the feature largely in terms of examples.
27-
- Explaining any changes to existing workflows.
28-
- Design mock-ups or diagrams depicting any new UI that will be introduced.
2962

3063

3164
**_Part 2 - Additional information_**

0 commit comments

Comments
 (0)