docs icon indicating copy to clipboard operation
docs copied to clipboard

Dismissing a review causes reviewed event to be in `dismissed` state

Open taylorhakes opened this issue 1 year ago • 10 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/developers/webhooks-and-events/events/issue-event-types#reviewed

What changes are you suggesting?

Ideally change the behavior of the API to keep the state of the original review. Currently the state of the review is dismissed which is not a valid value in the enum. It is really important to keep the state of the original review somewhere, so we can see what happened.

Additional information

To reproduce:

  • Review a PR
  • Have the author dismiss the review

The reviewed event is now in dismissed state instead of it's original review state

Content plan here

taylorhakes avatar Aug 27 '22 15:08 taylorhakes

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Aug 27 '22 15:08 welcome[bot]

@taylorhakes Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:

cmwilson21 avatar Aug 29 '22 13:08 cmwilson21

@taylorhakes - Just for clarification, are you requesting a change in the documentation over dismissing a review? Or is this a request to update the behavior of the API?

cmwilson21 avatar Aug 29 '22 13:08 cmwilson21

Hey @cmwilson21. I am requesting both. The immediate fix is to document this behavior in the docs. It would be amazing to fix this behavior to show the original review state, but I don’t know how much work that would be because the code isn’t open source.

taylorhakes avatar Aug 29 '22 13:08 taylorhakes

BR1MO IMG_20220823_165602 Title-2129591171 Title720759873 Uploading Title-342413846.jpg…

BRIMO-DATA avatar Aug 29 '22 14:08 BRIMO-DATA

Title-342413846

BRIMO-DATA avatar Aug 29 '22 14:08 BRIMO-DATA

Thanks for clarifying @taylorhakes! We can take a look at the documentation side. For the feature feedback, it would be best to leave that over in the communities feedback discussions.

We will check it out from the docs side of things. Thanks again for raising an issue! 💛

cmwilson21 avatar Aug 29 '22 21:08 cmwilson21

Thanks for this issue! You or anyone else is welcome to open a PR to update the docs to reflect that the dismissed state exists.

skedwards88 avatar Aug 30 '22 18:08 skedwards88

Opensorce/runpandora/yh5aitec

nzbitcoinme avatar Sep 01 '22 12:09 nzbitcoinme

Hi! I'd like to work on this. I'm not clear on what excactly needs to be changed. I'm just starting with open source so any help would be great:)

Anika-Roy avatar Oct 26 '22 09:10 Anika-Roy

@cmwilson21 Can we at least list the dismissed state in the documentation for reviewed? The docs still make no mention of dismissed

taylorhakes avatar Aug 14 '23 14:08 taylorhakes

@taylorhakes Sorry for the confusion - stalebot closed this one out when it shouldn't have been closed. Reopening and will triage your PR 👍

cmwilson21 avatar Aug 14 '23 17:08 cmwilson21

ในวันที่ อ. 15 ส.ค. 2023 14:22 น. Ben Ahmady @.***> เขียนว่า:

Closed #20216 https://github.com/github/docs/issues/20216 as completed via #27446 https://github.com/github/docs/pull/27446.

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/20216#event-10094410596, or unsubscribe https://github.com/notifications/unsubscribe-auth/A7CM5LZ2ISZEFXDUDRWAFYDXVMPTPANCNFSM57ZOXF3A . You are receiving this because you are subscribed to this thread.Message ID: @.***>

pakonkiat2543 avatar Aug 15 '23 07:08 pakonkiat2543