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

Commit b74359b

Browse files
committed
add section on "add comment" gutter icon flow
1 parent e309b2f commit b74359b

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,35 @@ The header looks very similar to the one of All Reviews tab, with the exception
6464
![image](https://user-images.githubusercontent.com/6842965/56695406-fdd22700-66b6-11e9-9e7e-fe85e2507a66.png)
6565

6666

67+
### "Add comment" gutter icon
68+
69+
A user can start a review or add a comment to an existing pending review by clicking on the "add comment" icon which shows up on hover over the gutter of:
70+
71+
1. MultiFilePatch view within Files tab in `PullRequestDetailView`
72+
2. an editor *if on a checked out PR branch*
73+
74+
The flow of starting a review or adding a comment from the gutter varies a bit depending on the state of reviews:
75+
76+
* If there is no reviews at all
77+
1. User clicks on "add comment" icon in gutter
78+
2. *Pending reiview* dock opens in empty state
79+
3. New comment block is added to the pending review dock
80+
81+
82+
* If there are existing reviews and no pending review
83+
1. User clicks on "add comment" icon in gutter
84+
2. *All reviews* dock open
85+
3. New comment block is added to the all reviews dock
86+
4. User can choose between "Add a single comment" or "start a review"
87+
5. a) "add single comment": comment is added to the all reviews dock
88+
b) "start a review": user is redirected to the pending dock with the newly added pending comment there
89+
90+
91+
* If there is a pending review
92+
1. User clicks on "add comment" icon in gutter
93+
2. *Pending reviews* dock open
94+
3. New comment block is added to the pending review dock
95+
6796

6897
### Reviewer Workflow
6998

0 commit comments

Comments
 (0)