Pull Request Review Template

Is there a way to apply a template to Pull Request reviews?

It would be beneficial to allow repositories to specify steps for the reviewer to take and things to look for. 

I would imagine this would implemented in a similar fashion to the existing Pull Request template.

62 Likes

Hi @lanej,

Thanks for being part of the GitHub Community Forum!

If I’m understanding your request correctly, you should be able to do this with the existing PR template feature. I’ve actually used this myself in some of my own projects to help guide reviewers on the steps they should take when going through my PRs.

The way that I do it, is to incorporate a checklist for reviewers into my PR template. So, whenever I open a PR, the checklist automatically populates in the PR body. I can then add any other instructions specific to that PR, if needed, and add the reviewers I need to take a look at the PR. Each reviewer will then be able to see the checklist and follow it to ensure they’ve taken all the steps I need them to to finish a review.

Is this what you’re looking for? If that’s not quite what you need, please do let me know a few more details and I’ll be sure to share it with the appropriate teams as a feature request.

Based on the title and description, I think @lanej and I are both looking for a template for the Pull Request Review , the text box shown when clicking “Review Changes”, not the Pull Request description/content.

Screen Shot 2018-06-11 at 12.17.36 PM.png

17 Likes

@spalger and I are on the same page

Hi @lanej and @ansspage,

Thanks for this feedback and the additional information! We’re always working to improve GitHub and the GitHub Community Forum, and we consider every suggestion we receive. I’ve logged your feature request in our internal feature request list. Though I can’t guarantee anything or share a timeline for this, I can tell you that it’s been shared with the appropriate teams for consideration.

Please let me know if you have any other questions.

Thanks!

7 Likes

Thanks! This would be so incredibly helpful because it happens in the workflow of the actual review!

I was looking for a feature like this too. I wanted to include the following in ‘Review summary’ input box whenever someone goes to review code:
Reviewer checklist

  • [] Read PR description
  • [] Read AC
  • [] Pulled branch, manually tested, verified AC are met
  • [] Reviewed the code
1 Like

Hi @melaniebrgr

Thanks for this feedback and the additional information! I will include this our internal feature request list. 

Though I can’t guarantee anything or share a timeline for this, I can tell you that it’s been shared with the appropriate teams for consideration.

Please let me know if you have any other questions.

Cheers!

+1

It would be a great workflow improvement to be able to specify a template for the Review Summary textbox. Right now my team and I have to copy/paste the checklist we use for PR reviews everytime we complete a review.

6 Likes

Where can we follow the progress on this feature ? I’ll want to use it as soon as it’s available.

4 Likes

There is not a public GitHub-owned feature request list at this time. However, to get the most up to date news on new features, I recommend subscribing to our changelog and/or blog. That’s where you’ll get the most immediate news if and when new features are available.

1 Like

+1

I’d like to make a template with a checklist that appears when one starts a PR review.

I was considering using a GitHub action when I came across https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/ and wondered whether the analog existed for PR reviews.

+1 for this feature.

Would love to be able to specify steps for reviewing PRs

2 Likes

+1 for this feature

4 Likes

Maybe also some updates over if this is even being considered, if the team have some concerns or comments about this request, or if it’s just in a backlog and may be taken at some uncertain point when higher priority things are solved… just to have some expectation on how it is going.

1 Like

+1

This would be extremely helpful feature - where can we find the status of this request?

This would be super helpful.

+1 for this feature

+1 for this feature!!

We need it!!!

3 Likes

+1 on this feature request