Skip to content

Commit 69ab065

Browse files
committed
updated Readme
1 parent ccc1ad9 commit 69ab065

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
11
## AWS Stale Discussion Bot
22

3-
* Purpose: OSDS will mark discussion answers as proposed-answer and after N number of days, the bot will go in and automatically mark that answer as the discussion answer.
3+
### Purpose
44

5-
* Normal case: Discussion is opened, OSDS answers it, says @bot propose-answer.
5+
OSDS will mark answerable discussions with keyword `@bot prposed-answer`, along with proposed answer. Based on reaction received , the appropriate action is taken to close/update the discussion. After N number of days in absence of any action, it's closed.
6+
7+
### Different scenarios
8+
9+
* Normal case: Discussion is opened, OSDS answers it, says @bot proposed-answer.
610
Bot then comments the thread with instructions to the customer. If the customer
7-
marks the discussion as answered, the bot removes the proposed-answer comment
8-
and any replies it made on the thread and closes the discussion as resolved. If the customer does not mark the discussion as answered, the bot ask OSDS to take another look and help the customer.
11+
marks the discussion as answered, the bot removes keyword and closes the discussion as resolved. If the customer does not mark the discussion as answered, the bot ask OSDS to take another look and help the customer.
12+
13+
* Edge case: The submitter thumbs down the proposed-answer. If that happens, a label `attention` is added , for further traction by OSDS Team.
914

10-
* Edge case: The submitter thumbs down the proposed-answer. If that happens, the bot will comment with a mention to the OSDS team member that the answer is not right, to take another look.
1115
* Edge case: The discussion gets locked. Bot will take no action on locked
1216
discussions.
17+
1318
* Edge case: The discussion gets moved. Bot should take normal actions on moved
1419
discussions unless it gets moved into a category that's not answerable, in which case the bot will comment that it's unable to do anything further.
15-
* Edge case: Bot waits for submitter's response on the suggested answer. If there is no response after 7 days, a reminder is sent to submitter to take action on proposed answer. In absence of response for next 4 days, discussion is closed as being stale.
20+
21+
* Edge case: Bot waits for submitter's response/reaction on the suggested answer. If there is no response after 7 days, a reminder is sent to submitter to take action on proposed answer. In absence of response for next 4 days, discussion is closed as being outdated.
22+
1623
* Edge case: There are multiple proposed answers. Newer proposed answers will take precedence over older ones.
1724

1825
## Setup
1926

20-
Follow this [Setup guide](handle-stale-discussions/SETUP.md).
27+
Follow this [Setup guide](SETUP.md).
2128

2229
## Security
2330

0 commit comments

Comments
 (0)