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

Commit 942238e

Browse files
committed
add some outline for the workflow explanation
1 parent a9ee940 commit 942238e

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

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

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
<!---
2-
For community contributors -- Please fill out Part 1 of the following template. This will help our team collaborate with you and give us an opportunity to provide valuable feedback that could inform your development process. Sections in Part 2 are not mandatory to get the conversation started, but will help our team understand your vision better and allow us to give better feedback.
3-
--->
4-
51
**_Part 1 - Required information_**
62

73
# Pull Request Review -- Reviewer Flow
@@ -60,6 +56,36 @@ The header looks very similar to the one of All Reviews tab, with the exception
6056

6157

6258

59+
### Reviewer Workflow
60+
61+
**Note**: In the name of clarity, in this RFC we will differentiate between "new comment" and "pending comment":
62+
- a new comment: _after_ a user decides to add a comment from the gutter, and _before_ the user actually adds it to a pending review. (i.e. a pending-pending comment, if you prefer confusion. :laughing:)
63+
- a pending comment: already added to a pending review
64+
65+
#### 1. Start a review
66+
67+
##### From the gutter
68+
69+
within Files tab in `PullRequestDetailView`
70+
within an editor
71+
72+
If user has checked out a PR branch, an "add comment" icon should show up *on hover* over the gutter of an editor of any file. Clicking on the icon will either activate new comment
73+
74+
Nothing if not on a PR branch.
75+
76+
##### By responding to a thread
77+
78+
#### 2. Continue a review
79+
80+
81+
82+
#### 3. Submit a review
83+
- The only way to submit a review within Atom is by using the "Submit review" button in the Pending Review tab
84+
- the button will be disabled if a review type has not been chosen from the dropdown menu
85+
- if there is any new comment that has not been added to the pending review, a warning modal should pop up
86+
- after publishing, the Pending Review tab will be destroyed. User will be led back to the All Reviews tab, which will immediately reflect the just published review.
87+
88+
--------------------
6389

6490
**_Part 2 - Additional information_**
6591

0 commit comments

Comments
 (0)