Help
cancel
Showing results for 
Search instead for 
Did you mean: 
Highlighted
Copilot Lvl 2
Message 1 of 14

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.

13 Replies
Moderator
Message 2 of 14

Re: Pull Request Review Template

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.

Mark helpful posts with Accept as Solution to help other users locate important info. Don't forget to give Kudos for great content!

Copilot Lvl 2
Message 3 of 14

Re: Pull Request Review Template

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

 

 

Copilot Lvl 2
Message 4 of 14

Re: Pull Request Review Template

@spalger and I are on the same page
Community Manager
Message 5 of 14

Re: Pull Request Review Template

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!

Ground Controller Lvl 1
Message 6 of 14

Re: Pull Request Review Template

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

Ground Controller Lvl 1
Message 7 of 14

Re: Pull Request Review Template

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

Community Manager
Message 8 of 14

Re: Pull Request Review Template

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!

Be sure to click Accept as Solution to mark helpful posts to help other users locate important info. Also, don't forget to give Kudos for great content!

Ground Controller Lvl 1
Message 9 of 14

Re: Pull Request Review Template

+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.

Copilot Lvl 2
Message 10 of 14

Re: Pull Request Review Template

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