Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe how to re-request a review #897

Closed
HonkingGoose opened this issue Oct 28, 2020 · 5 comments · Fixed by #953
Closed

Describe how to re-request a review #897

HonkingGoose opened this issue Oct 28, 2020 · 5 comments · Fixed by #953
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@HonkingGoose
Copy link
Contributor

What article on docs.github.com is affected?

I think we should update one of the subsections belonging to this main section:

https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests

What part(s) of the article would you like to see updated?

Why should the docs be changed?

I can't find anything in the GitHub docs about re-requesting a review??? I would expect it to be in one of the articles in the Reviewing changes in pull requests section, but I can't find it there at all.

What use cases does it support?

This should be documented somewhere, so that repository maintainers can link to this section to explain how "re-requesting an review" works.

This also exposes this functionality to anyone who reads the GitHub docs, that way they can "stumble into" this functionality.

Expected outcome

There is a section in the GitHub docs that explains that you can click on the refresh icon next to a review, to ping the reviewer for a fresh review.

Additional information

See the image below for an example of the refresh icon that I'm talking about:

image

@welcome
Copy link

welcome bot commented Oct 28, 2020

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 28, 2020
@janiceilene
Copy link
Contributor

👋 @HonkingGoose I don't see anything about re requesting a PR review either! It sounds to me like you're interested in an addition that focuses on a contributor requesting an additional review after they've made changes in an already reviewed PR. Is that right?

The article you linked to above ☝️ Reviewing changes in pull requests is aimed at the reviewer, so I don't think that's quite the right place for this information to live.

What about adding it to either About pull request reviews? Or maybe Incorporating feedback in your pull request, since that article focuses on how to apply suggested changes and open an issue for out of scope suggestions?

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team core and removed triage Do not begin working on this issue until triaged by the team labels Oct 28, 2020
@HonkingGoose
Copy link
Contributor Author

HonkingGoose commented Oct 29, 2020

First of all, thanks for the quick response! 😄

It sounds to me like you're interested in an addition that focuses on a contributor requesting an additional review after they've made changes in an already reviewed PR. Is that right?

Yes, that's right! 😄

The article you linked to above ☝️ Reviewing changes in pull requests is aimed at the reviewer, so I don't think that's quite the right place for this information to live.

Agree, it should go somewhere else.

What about adding it to either About pull request reviews?

Sounds good to me, I think I like this place better than " Incorporating feedback in your pull request", as that seems to me more focused on the review feedback. I can see the case for both places though.

I think some keywords should be: "refresh review", "ping for a fresh review", "re-request review", I think words like that are what people would use when searching trough the documentation. I know I typed in "re-request review" and "request review" to try to find this documentation.

@janiceilene
Copy link
Contributor

The hover text says "re-request review," so I think that's what we should use here. I think it'd be beneficial to add the information to both articles. So what we can do is create a new reusable in https://github.com/github/docs/tree/main/data/reusables/pull_requests that includes:

  • a sentence or two about why someone would want to re-request a review (like after making substantial changes)
  • a quick explanation of how to re-request a review, using the sync octicon

We can add a new section called "Re-requesting reviews" to the About pull request reviews article after the "Resolving conversations" section with that reusable. We can also add a new section and reusable to Incorporating feedback in your pull request after the procedural, above the "Opening an issue for an out-of-scope suggestion" section.

Anyone is welcome to open a PR implementing that plan if you want to!

@HonkingGoose
Copy link
Contributor Author

HonkingGoose commented Oct 31, 2020

I'll go make a PR for this then. 👍

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@janiceilene @HonkingGoose and others